Skip to navigation

Flows · Workflows · Find runnable workflows and their input schemas

View as Markdown

Lists published (ACTIVE) workflows in this workspace, each with an inputs JSON Schema declaring the parameters a run accepts. Drafts are not listed.

Workspaces routinely hold 200+ workflows and some carry large input schemas, so pass search rather than paging blindly. It matches title, description and creator name — substring, case insensitive.

Returns a paginated envelope: count, next, previous, and results[] of {id, title, description, inputs}. id is the workflow-definition ID.

Gotcha: inputs is {} both when a workflow genuinely takes no inputs and when its schema could not be built. If {} looks wrong for a workflow that clearly needs parameters, the definition is likely unpublished or broken — check it in the Simplified editor rather than starting it and hoping.

resource: workflow://run-control covers how this fits the run loop.

Authentication

AuthorizationApi-Key

Header authentication of the form Api-Key <token>

OR
AuthorizationBearer

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

Query parameters

searchstringOptional

Substring match over title, description and creator name. Strongly preferred over paging — see above.

idintegerOptional
Return only the workflow with this ID.
idsstringOptional

Comma-separated workflow IDs, to fetch several at once.

creatorintegerOptional
Restrict to workflows created by this numeric user ID.
pageintegerOptional

1-based page number.

page_sizeintegerOptional
Results per page. Defaults to 10.

Response

Paginated list of runnable workflows with input schemas.

Errors

401
Unauthorized Error