v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Workflows API

List Workflows

Use this endpoint to retrieve a paginated list of workflows. You can filter results by status.

get/v1/workflows

Query parameters

status'draft' | 'active' | 'inactive'

Filter results by status.

limitinteger

Maximum number of items to return per page. Defaults to 10. Must be between 1 and 100.

cursorstring

Cursor for pagination. Use the value from the nextCursor field in a previous response to retrieve the next page.

sortBy'createdAt' | 'updatedAt' | 'name'

Field to sort results by.

sortOrder'ASC' | 'DESC'

Sort direction. Use ASC for ascending or DESC for descending.

Response

Indicates that the request was successful and the response contains the requested data.

hasMoreboolean

Indicates whether more pages are available.

nextCursorstring

Cursor to pass in the next request to retrieve the following page.

Example response

{
  "items": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Payment Notification Flow",
      "description": "Receives a webhook trigger and logs the payment event.",
      "status": "active",
      "nodes": [
        {
          "id": "trigger-1",
          "type": "trigger",
          "name": "Webhook Trigger",
          "position": {
            "x": 0,
            "y": 0
          },
          "data": {
            "triggerId": "webhook"
          }
        },
        {
          "id": "log-event",
          "type": "action",
          "name": "Log Payment Event",
          "position": {
            "x": 200,
            "y": 0
          },
          "data": {
            "action": "log"
          }
        }
      ],
      "edges": [
        {
          "id": "e1",
          "source": "trigger-1",
          "target": "log-event"
        }
      ],
      "metadata": {
        "team": "payments"
      },
      "createdAt": "2026-03-17T14:30:00Z",
      "updatedAt": "2026-03-17T14:31:00Z"
    }
  ],
  "nextCursor": "",
  "hasMore": false
}