Docs

List Workflows

See every workflow in your company. Filter and sort by any field, like isActive or createdOn.

GET

Headers

Optional headers
string

Optional. The id of a child organization of your API key's company to act on. Leave it out to act on the key's own company. See Child organizations.

Query

FiltersNarrow list results with a provider-supported where expression. Learn more
string

RSQL expression used to filter list results.

PaginationRequest a specific window of rows with limit and offset. Learn more
number

Maximum number of rows to return.

number

Number of rows to skip.

SortingChoose the order of returned rows when this action supports sorting. Learn more
string

Comma-separated sort fields; prefix with - for descending.

Field selectionChoose which fields should be included in the response. Learn more
string

Comma-separated response fields to include.

Response fields

idstring

Unique id of the workflow.

namestring

The name your team gave the workflow.

typestring

The workflow's type.

isActiveboolean

True while the workflow is enabled and able to run.

isTemplateboolean

True if this is a template rather than a live workflow.

sizestring

The workflow's runner size: xs, sm, md, lg, xl, or xxl. Empty when sized automatically.

tagsarray of string

Ids of the tags on the workflow. The tag catalog is managed in the app.

createdOndate

When the workflow was created.

createdBystring

Who created it.

updatedOndate

When it was last changed.

updatedBystring

Who last changed it.