Skip to main content
GET
List a workflow's schedules and other triggers
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/listTriggers?workflowId=<workflowId> Returns one page of a workflow’s schedules and other triggers, newest first. Each trigger shows its kind, its timing, whether it follows the active version or pins one, the org unit its fires run at, and when it fires next. To change a trigger, use createTrigger, updateTrigger and the other trigger writes; to list triggers across workflows, use listScheduleRoster.

Authentication

External App credential or platform API key. Requires permission workflows:read, held at two homes:
  • the workflow’s home org unit, and
  • each trigger’s orgUnitId, the org unit its fires run at. Runs that a trigger starts are recorded there, so a caller that reads the trigger must be able to read there too.
A trigger at an org unit the caller cannot read is left out of the page. The org unit a request acts from is not a record’s home, and a trigger’s owner or creator never grants access.

Query parameters

string
required
The workflow ID.
integer
default:"25"
Rows to read for this page, 1 to 50 (one read decides at most 50 org units, and each trigger names one). A larger value is 400 too_big. Zero, negative, fractional, non-numeric, empty or repeated values answer 400.
string
meta.nextCursor from the previous page.

Paging

A page reads limit triggers and then leaves out the ones the caller cannot read, so a page can be short or empty while meta.hasMore is true. Follow meta.nextCursor until hasMore is false. Every trigger the caller can read arrives on some page.

Responses

data is an array of trigger objects. Each has the fields described in getTrigger.

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.

Path Parameters

workflowId
string
required

Workflow document id.

Minimum string length: 1

Query Parameters

limit
integer
default:25

Rows to read for this page, 1 to 50 (one read decides at most 50 org units, and each trigger names one). A larger value is 400 too_big; zero, negative, fractional, non-numeric, empty or repeated values answer 400 bad_request.

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

Opaque cursor: meta.nextCursor from the previous page.

Response

Trigger list

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.