v1

latestOpenAPI 3.1.02026-08-06284092.1 KB
workflows

List workflows

Return workflows visible to the caller.

System workflows are visible to everyone. For org workflows, visibility is role-scoped: ADMIN and OWNER see every workflow in the active org. VIEWER and MEMBER see the workflows they own plus any in a group they belong to; a member in the virtual "All workflows" group sees every org workflow (VA-499).

get/api/v2/workflows

Query parameters

cursorstring nullable

Opaque pagination cursor.

Opaque pagination cursor.

limitinteger nullable

Page size (max 200).

Page size (max 200).

is_systemboolean nullable

If true, only system workflows. If false, only user workflows.

If true, only system workflows. If false, only user workflows.

mineboolean

If true, restrict to workflows owned by the active org (organization_id == active org). Combine with is_system=true to list the system workflows this org promoted (its manage view).

If true, restrict to workflows owned by the active org (organization_id == active org). Combine with is_system=true to list the system workflows this org promoted (its manage view).

owned_by_meboolean

If true, restrict to workflows whose owner_user_id is the caller. Used by the post-login redirect on the web app to decide between the empty-state and the workflow list.

If true, restrict to workflows whose owner_user_id is the caller. Used by the post-login redirect on the web app to decide between the empty-state and the workflow list.

status'active' | 'draft' | 'deleted'

Lifecycle state of a workflow row.

Transitions: draft -> active -> deleted. Non-draft rows skip to active on creation.

Filter by lifecycle status. Omitted (default) lists only 'active' workflows and hides drafts. Pass 'draft' to list the caller's own drafts (drafts are private to their author, never shown to others or counted against the plan).

tagsstring[] nullable

Filter to workflows carrying any of the given tags. Repeat the param for multiple tags.

Filter to workflows carrying any of the given tags. Repeat the param for multiple tags.

qstring nullable

Substring match against workflow name/description (case-insensitive).

Substring match against workflow name/description (case-insensitive).

Response

Successful Response

next_cursorstring nullable

Opaque cursor to fetch the next page. Null when this is the last page.

limitinteger required

Page size that was applied.

Example response

{
  "limit": 50
}