Skip to content

List workflows

GET/workflows

Returns a paginated list of all workflows ordered by most recently updated, enriched with run counts, version counts, and simulation counts. Use this to manage the automation library and quickly identify active versus draft workflows.

Request

Query parameters

NameTypeRequiredDescription
pageintegerNo

Page number (15 workflows per page).

Default: 1

statusstringNo

Filter by workflow status.

One of: "draft", "active", "archived"

Responses

200 Paginated workflow list with aggregate counts

Content type application/json, object.

FieldTypeRequiredDescription
dataarray of object · WorkflowDefinitionV1No
data[].idintegerNo

Auto-incremented primary key.

data[].namestringNo

Human-readable workflow name.

Example: "New Lead Welcome Email"

data[].descriptionstring, nullableNo

Optional explanation of the workflow's purpose.

data[].triggerobjectNo

Trigger configuration. Stored as either a plain string event name or a structured object with an 'event' key and optional filter properties.

data[].conditionsarray of objectNo

Array of condition objects that must all evaluate to true before actions are executed. Each condition has a 'field', 'operator', and 'value' key.

data[].actionsarray of objectNo

Ordered array of action objects executed sequentially when the workflow fires. Each action has a 'type' and 'config' object.

data[].throttle_per_minuteintegerNo

Maximum executions per minute (0 = unlimited).

Example: 100

data[].error_policystringNo

Error handling strategy for failed actions.

One of: "retry", "halt", "dlq" · Example: "retry"

data[].statusstringNo

Workflow lifecycle status.

One of: "draft", "active", "archived" · Example: "active"

data[].runs_countintegerNo

Total number of execution runs for this workflow.

Example: 247

data[].versions_countintegerNo

Number of saved version snapshots.

Example: 3

data[].created_byinteger, nullableNo

Tenant user ID who created the workflow.

data[].updated_byinteger, nullableNo

Tenant user ID who last updated the workflow.

data[].created_atstring (date-time)No

Record creation timestamp.

data[].updated_atstring (date-time)No

Last update timestamp.

metaobjectNo
meta.current_pageintegerNo
meta.per_pageintegerNo
meta.totalintegerNo

Example

{
  "data": [
    {
      "id": 8,
      "name": "New Lead Welcome Email",
      "description": "Sends a welcome email when a new CRM lead is created.",
      "trigger": "crm.lead.created",
      "status": "active",
      "throttle_per_minute": 100,
      "error_policy": "retry",
      "runs_count": 247,
      "versions_count": 3,
      "simulations_count": 5,
      "created_at": "2026-02-10T08:00:00Z",
      "updated_at": "2026-03-15T14:22:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total": 22
  }
}

401 Unauthenticated

Example request

curl -X GET "https://{tenant}.faciotech.net/api/v1/workflows" \
  -H "Accept: application/json"
Loading