GET/v1/flows

List flows

Lists flows for a project, with optional filters for folder, name, status, version state, and related external IDs. Supply the required projectId, status, agentExternalIds, connectionExternalIds, and externalIds filters; use cursor and limit to navigate the results.

10 parameters
folderIdstringoptional
Filter flows by folder identifier.
limitnumberoptional
Maximum number of flows to return.
cursorstringoptional
Pagination cursor for retrieving a page of results.
statusarray<string>required
Filter by flow status: `ENABLED` or `DISABLED`.
projectIdstringrequired
The identifier of the project whose flows to retrieve.
namestringoptional
Filter flows by name.
agentExternalIdsarray<string>required
Filter by agent external IDs; each value is a string.
versionStatestringoptional
Filter by version state: `LOCKED` or `DRAFT`.
Allowed:LOCKEDDRAFT
connectionExternalIdsarray<string>required
Filter by connection external IDs; each value is a string.
externalIdsarray<string>required
Filter by flow external IDs; each value is a string.

1 status code
200Returns a paginated response with `data` containing flow objects and `next` and `previous` cursors.
dataarray<object>required
nextstringoptional
previousstringoptional

Error handling

Supply projectId, status, agentExternalIds, connectionExternalIds, and externalIds, which the query schema requires. status values must be ENABLED or DISABLED, and the external ID filters must contain string values.