Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Workflow

List Workflows

List the standalone automation workflows for a workspace. Supports cursor pagination and sort.

get/workspaces/{workspace_id}/workflows

Path parameters

workspace_idinteger required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

OK

idinteger

Workflow ID

public_idstring nullable

Obfuscated workflow ID

workspace_idinteger

Integer ID of the workspace that owns this workflow

namestring

Human-readable workflow name

status'draft' | 'live' | 'archived'

Derived status. live = enabled with at least one active trigger; archived = archived; otherwise draft.

disabledboolean

True when the workflow is disabled (not executing runs).

archivedboolean

True when the workflow has been archived.

run_type'asynchronous' | 'synchronous' | 'one_time'

How the workflow handles concurrent runs for the same contact. Server-controlled — always asynchronous for API-created workflows.

active_runs_countinteger

Number of currently active (in-progress) runs.

completed_runs_countinteger

Cumulative count of completed runs.

created_atstring date-time

Creation timestamp

updated_atstring date-time

Last update timestamp

Example response

[
  {
    "id": 101,
    "public_id": "WfAbCd",
    "workspace_id": 5001,
    "name": "New Lead Nurture",
    "status": "live",
    "disabled": false,
    "archived": false,
    "run_type": "asynchronous",
    "active_runs_count": 12,
    "completed_runs_count": 340,
    "created_at": "2025-06-01T00:00:00.000Z",
    "updated_at": "2025-06-10T00:00:00.000Z"
  }
]