Sign in
latestOpenAPI 3.0.32026-08-19299284712.8 KB

67d9f45bb99b

Workflow

List workflow executions.

Paginated registered executions with optional metadata.counts (when count_by is set) and metadata.pagination; omits unregistered workflow paths.

get/company/workflow-executions

Query parameters

count_bystring

Dimensions for metadata.counts grouping. Repeat or comma-separate. Allowed: created_at (UTC hour), started_at (UTC hour), status, started_by (alias created_by). Counts use DB aggregation over the latest execution per workflow (registered paths only), honor exclude_cleared, and ignore since, type_id, and status list filters. When absent, metadata.counts is omitted (use metadata.pagination.total_items).

exclude_clearedstring

When true, omit executions dismissed via clear.

limitinteger

Page size (default 25, max 500). Invalid values return 400.

pageinteger

Page number (v1.2 list is always paginated).

sinceinteger

Hours to look back for workflow executions (v1.2 filters on created_at, not started_at).

statusstring

Filter the list by status (QUEUED, PROCESSING, FAILED, COMPLETED, CANCELLED). Repeat or comma-separate for OR (e.g. status=PROCESSING,QUEUED for active). Does not affect metadata.counts. On v1.2, QUEUED means enqueued but not yet started.

type_idstring

Filter to a registered workflow type id from the catalog.

Headers

HTTP_ACCEPTstring required

Set the version of API the request is for

X-Company-IDstring required

Associates request with company

Response

idinteger required
statusstring required
namestring required
typestring required
metadataobject required
started_atstring nullable required
can_retryboolean required
can_cancelboolean required
canceled_atstring date-time required
completed_atstring date-time nullable required
last_status_change_atstring date-time required
type_idstring nullable required
catalog_versioninteger nullable required
created_atstring date-time required
retried_bystring required
canceled_bystring required
current_stage_idstring nullable required
created_bystring required
triggered_bystring required