WorkflowsVersion: v3

Search Workflows

POST/workflows/search

Limited availability. The workflow API is currently enabled for selected sub-accounts only; any other sub-account receives 403 WORKFLOW_API_NOT_ENABLED_FOR_LOCATION.

Find workflows in a sub-account by name, status, folder or timestamp. Returns summaries only — pass an ID to Get Workflow Definition for the full definition.

Filters are combined with AND. Page with offset for the first few pages and switch to the searchAfter cursor for deeper paging; sending both is rejected.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:workflows.readonly

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

API Version. Send v3.

Available optionsv3

Example:v3

Query Parameters

locationIdstringrequired

Sub-account (location) ID the workflow belongs to

Example:ve9EPM428h8vShlRW1KT

Body

application/json

filtersobject[]

Filters, combined with AND. Max 20. Omit to match every workflow in the sub-account.

To fetch a known set of workflows, filter workflowId with in. The sub-account scope still applies, so an id from another sub-account simply matches nothing.

sortobject[]

Sort order. Defaults to most recently updated first.

limitnumber

Page size

Default:20

Example:20

offsetnumber

Result offset. Cannot be combined with searchAfter. Deep paging is expensive — prefer searchAfter past the first few pages.

Example:0

searchAfterstring[]

Cursor from a previous response, for stable paging through a large result set. Send it back verbatim; do not construct one.

Example:["1735689600000"]

Response

application/json

Successful response

totalnumberrequired

Total matches, ignoring paging

Example:137

countnumberrequired

Number returned in this response