List schedule flows
Returns a keyset page of the org's flows, optionally filtered by status (comma-separated).
query Parameters
statusFilter by status (comma-separated)
Filter by status (comma-separated)
limitPage size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.
cursorOpaque continuation token from the previous response's pagination.cursor. Omit for the first page. Cursors are stateless and do not expire, but are only valid for the list and filters that produced them.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
List schedule flows › Responses
OK
Create a schedule flow (draft)
Authors a new draft flow. Requires a user session — authorship must be attributable to a person, not an API key.
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Create a schedule flow (draft) › Request Body
descriptionOptional longer description of what the flow does.
Dependency edges between steps (the DAG arcs).
failure_policyHow the flow reacts to a step failure; defaults to continue_independent.
nameOperator-facing name of the flow.
priorityScheduling priority; higher-priority flows are advanced first when several are due.
The flow's step nodes (the DAG vertices).
target_bindingWhen bulk-step targets are resolved — snapshot at activation or live at fire time; defaults to snapshot_at_activate.
trigger_localWall-clock local time the flow should fire, paired with trigger_tz; both nil means run immediately on activation.
trigger_tzIANA timezone for trigger_local (e.g. Europe/Berlin); must be set together with it.
Create a schedule flow (draft) › Responses
Created
Preview a bulk-op target set (count, sample, money impact)
Resolves a subscription selector to a blast-radius readout {count, sample, money_impact_estimate} without mutating anything. The money estimate is computed only for a change_version preview with a concrete target, and is bounded (estimated_over reports the coverage) so the preview stays responsive.
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Preview a bulk-op target set (count, sample, money impact) › Request Body
actionforcetarget_latesttarget_versionPreview a bulk-op target set (count, sample, money impact) › Responses
OK
Get a schedule flow graph
Returns a flow's full graph (steps + edges + run state); the monitor polls this.
path Parameters
idFlow UUID
Flow UUID
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Get a schedule flow graph › Responses
OK
Update a draft schedule flow
Replaces a draft flow's metadata + graph under an optimistic lock: expected_version must carry the lock_version last read, and a stale value or a non-draft flow yields 409.
path Parameters
idFlow UUID
Flow UUID
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Update a draft schedule flow › Request Body
descriptionOptional longer description of what the flow does.
Dependency edges between steps (the DAG arcs).
expected_versionOptimistic-lock token: the lock_version the client last read; a stale value or a non-draft flow 409s.
failure_policyHow the flow reacts to a step failure; defaults to continue_independent.
nameOperator-facing name of the flow.
priorityScheduling priority; higher-priority flows are advanced first when several are due.
The flow's step nodes (the DAG vertices).
target_bindingWhen bulk-step targets are resolved — snapshot at activation or live at fire time; defaults to snapshot_at_activate.
trigger_localWall-clock local time the flow should fire, paired with trigger_tz; both nil means run immediately on activation.
trigger_tzIANA timezone for trigger_local (e.g. Europe/Berlin); must be set together with it.
Update a draft schedule flow › Responses
OK
Activate a draft schedule flow
Moves a draft flow to scheduled, resolving its trigger instant. Requires a user session (author ≠activator is the second pair of eyes).
path Parameters
idFlow UUID
Flow UUID
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Activate a draft schedule flow › Responses
OK
Cancel a schedule flow
Cancels a flow and all of its non-terminal steps.
path Parameters
idFlow UUID
Flow UUID
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Cancel a schedule flow › Responses
OK
Pause a schedule flow
Halts advancing a scheduled/running flow.
path Parameters
idFlow UUID
Flow UUID
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Pause a schedule flow › Responses
OK
Resume a paused schedule flow
Returns a paused flow to running (or scheduled if its trigger is future).
path Parameters
idFlow UUID
Flow UUID
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Resume a paused schedule flow › Responses
OK
Approve an approval-gate step
Approves an approval_gate step (awaiting_approval → succeeded).
path Parameters
idFlow UUID
Flow UUID
sidStep UUID
Step UUID
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Approve an approval-gate step › Responses
OK
List a fan-out step's per-target results
Returns a keyset page of a step's fan-out results, with per-status totals in pagination.counts so the monitor's summary need not page through every row.
path Parameters
idFlow UUID
Flow UUID
sidStep UUID
Step UUID
query Parameters
statusFilter by item status (comma-separated)
Filter by item status (comma-separated)
limitPage size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.
cursorOpaque continuation token from the previous response's pagination.cursor. Omit for the first page. Cursors are stateless and do not expire, but are only valid for the list and filters that produced them.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
List a fan-out step's per-target results › Responses
OK
Reject an approval-gate step
Rejects an approval_gate step (awaiting_approval → cancelled).
path Parameters
idFlow UUID
Flow UUID
sidStep UUID
Step UUID
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Reject an approval-gate step › Responses
OK
Retry a failed step
Re-arms a failed step.
path Parameters
idFlow UUID
Flow UUID
sidStep UUID
Step UUID
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Retry a failed step › Responses
OK
Skip a step
Marks a step skipped — an operator assertion the work is done or unneeded.
path Parameters
idFlow UUID
Flow UUID
sidStep UUID
Step UUID
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Skip a step › Responses
OK
List a step's status-change timeline
Returns a keyset page of a step's status-change audit records, newest first — the monitor's per-step timeline.
path Parameters
idFlow UUID
Flow UUID
sidStep UUID
Step UUID
query Parameters
limitPage size. Values above the server-side cap are clamped (standard default 50, cap 200; a few document-heavy lists use larger windows). Invalid values fall back to the default.
cursorOpaque continuation token from the previous response's pagination.cursor. Omit for the first page. Cursors are stateless and do not expire, but are only valid for the list and filters that produced them.
Headers
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
List a step's status-change timeline › Responses
OK
Unschedule a flow (scheduled→draft)
Returns a scheduled flow to draft so it can be edited.
path Parameters
idFlow UUID
Flow UUID
Headers
Idempotency-KeyUnique key that makes this POST safe to retry: repeats with the same key replay the first response instead of re-executing. Replays are scoped to the retrying principal (same API key / user) and kept for 24 hours. Required on every POST.
Client-generated idempotency key (e.g. a UUID).
X-Workspace-IdSelects the workspace this request operates in, by workspace UUID or slug (e.g. a sandbox workspace for test integrations). Omitted: the organization's default live workspace. Unknown workspace: 404; workspace outside your organization: 403. Discover workspaces via GET /workspaces.
Workspace UUID or slug.
Unschedule a flow (scheduled→draft) › Responses
OK