Skip to main content
GET
Python

Authorizations

Authorization
string
header
required

Enter your JWT token

Query Parameters

name
string | null

Optional substring match on the workflow name.

folderName
string | null

Optional substring match on the containing folder's name.

folderId
integer<int32> | null

Optional filter to one folder, by the id GET /v1/folders returns. Pass 0 for workflows in no folder. Combines with folderName.

enabled
boolean | null

Optional filter on whether the workflow is enabled.

blocked
boolean | null

Optional filter on whether the workflow is blocked from running.

deleted
boolean | null

Whether to return soft-deleted workflows. Defaults to false.

deletedAfter
string<date-time> | null

Optional inclusive lower bound on the deletion timestamp. Implies deleted=true; combining it with deleted=false is a 400. Workflows deleted through the legacy Solutions route before this release have no deletion timestamp and never match.

type
enum<string> | null

Optional trigger-type filter.

Available options:
instant,
automated,
scheduled,
workflowMCPTool,
onRefreshObjectList,
onRefreshObject,
onSaveSelectedObjects,
onActivityExecute,
onBeforeRequest
connectionId
integer<int32> | null

Optional filter to workflows with a step using this connection.

createdBy
integer<int32> | null

Optional account-user id filter on who created the workflow.

updatedBy
integer<int32> | null

Optional account-user id filter on who last updated the workflow.

updatedAfter
string<date-time> | null

Optional inclusive lower bound on the last-updated timestamp.

updatedBefore
string<date-time> | null

Optional inclusive upper bound on the last-updated timestamp.

lastRunAfter
string<date-time> | null

Optional inclusive lower bound on the last-run timestamp.

lastRunBefore
string<date-time> | null

Optional inclusive upper bound on the last-run timestamp.

sort
string | null

Optional sort over workflowId, name, updatedAt, lastRunAt. Comma-separated keys, each "field asc" or "field desc", highest priority first - e.g. "name asc,updatedAt desc". At most 3 keys; a field may appear once; every key needs an explicit direction when there is more than one; nothing may follow workflowId. A single key may omit the direction: workflowId then sorts descending, any other field ascending. Defaults to workflowId desc.

offset
integer<int32>
default:0

Zero-based index of the first item to return. Defaults to 0.

top
integer<int32>
default:100

Maximum number of items to return, capped at 100. Defaults to 100.

Response

A paginated list of workflows.

Offset-based paginated wrapper for a list of items.

items
object[]
required

The items in the current page.

totalCount
integer<int32>
required

Total number of items available across all pages.

offset
integer<int32>
required

Number of items skipped before this page (the requested offset).

top
integer<int32>
required

Maximum number of items requested for this page.