Skip to main content

WorkflowListResponse

Paginated list of workflows

entries object[]required

Array of workflows

  • Array [
  • created_atdate-timerequired

    When the workflow was created

    idstringrequired

    Unique workflow identifier (opaque ID)

    namestringrequired

    Workflow name

    statestringrequired

    Workflow state

    Possible values: [active, disabled, draft]

  • ]
  • metadata objectrequired

    Pagination metadata for paginated responses

    afterstringnullable

    Cursor for next page

    beforestringnullable

    Cursor for previous page

    limitintegerrequired

    Number of items per page

    WorkflowListResponse
    {
    "entries": [
    {
    "created_at": "2024-01-15T10:30:00Z",
    "id": "workflow_abc123",
    "name": "Send confirmation email",
    "state": "active"
    },
    {
    "created_at": "2024-01-15T10:30:00Z",
    "id": "workflow_abc123",
    "name": "Send confirmation email",
    "state": "active"
    }
    ],
    "metadata": {
    "after": "eyJpZCI6IndvcmtmbG93X2FiYzEyMyJ9",
    "before": null,
    "limit": 25
    }
    }