Skip to main content
GET
List the schedule roster across workflows
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

GET /api/v2/workflows/listScheduleRoster Returns one page of every trigger the caller may read, across workflows, newest first: the trigger, its workflow’s name and whether it is retired, its ingress configuration (never the token or a secret) and its latest run.

Authentication

External App credential or platform API key, or a Personal key. Requires permission workflows:read, held at two homes for each row: the workflow’s home org unit and the trigger’s orgUnitId, where the runs it starts are recorded. A trigger the caller cannot read is left out of the page; its owner or creator never grants access. lastRun is given only when the credential’s scopes reach runs:read and the caller holds runs:read at that run’s home and at every company on it, as every run read decides it; otherwise it is null.

Query parameters

integer
default:"25"
Rows to read for this page, 1 to 50.
string
meta.nextCursor from the previous page.
string
Only triggers whose fires run at this org unit.
string
Only this kind: cron, one_shot, ingress or email.
boolean
Only triggers that fire (true) or do not (false).
boolean
default:"false"
Include triggers of retired workflows.

Paging

A page reads limit triggers and then leaves out hidden, retired (unless includeRetired=true) and filtered rows, so a page can be short or empty while meta.hasMore is true. Follow meta.nextCursor until hasMore is false. meta.partial is true when a decision could not be made within one read; the rows it could not decide are left out.

Responses

data is an array of {trigger, workflow, ingress, lastRun}. trigger has the fields described in getTrigger; workflow is {id, name, retired}; ingress is null or the configuration described in updateIngressConfig; lastRun is null or {runId, status, startedAt}. Stored inputs, the owner and the creator are never returned.

Errors

Example

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

limit
integer
default:25

Rows to read.

Required range: 1 <= x <= 50
cursor
string

meta.nextCursor from the previous page.

orgUnitId
string

Only this org unit's triggers.

Minimum string length: 1
kind
enum<string>

Only this kind.

Available options:
cron,
one_shot,
ingress,
email
enabled
boolean

Only triggers that fire (true) or do not.

includeRetired
boolean
default:false

Include retired workflows.

Response

Success

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.