Workflows API

Create, read, update, and delete workflows programmatically.

List workflows

GET /v1/workflows

Returns all workflows in your account.

Query parameters

Parameter	Type	Description
state	string	Filter by state: draft, active, paused
limit	integer	Max results (default: 20, max: 100)
cursor	string	Pagination cursor from previous response

Example response

{
  "data": [
    {
      "id": "wf_abc123",
      "name": "Notify on GitHub issue",
      "state": "active",
      "created_at": "2026-01-15T10:00:00Z",
      "updated_at": "2026-02-01T08:30:00Z"
    }
  ],
  "next_cursor": "cur_xyz"
}

Get a workflow

GET /v1/workflows/{id}

Returns the full definition of a single workflow.

Create a workflow

POST /v1/workflows

Request body

{
  "name": "My workflow",
  "description": "Optional description"
}

Creating a workflow via API returns a draft with no steps. Use the visual builder to add triggers and actions, or use the update endpoint.

Update a workflow

PATCH /v1/workflows/{id}

Update the workflow's name, description, or state.

Request body

{
  "name": "Renamed workflow",
  "state": "paused"
}

Delete a workflow

DELETE /v1/workflows/{id}

Permanently deletes the workflow and all its run history. Active workflows must be paused before deletion.