v13

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-015232292.9 KB
Workflows

List Workflows

Retrieve all workflows in a workspace with cursor-based pagination.

get/api/v1/workflows

Query parameters

workspaceIdstring required

The unique identifier of the workspace.

folderIdstring

Filter results to only include workflows within this folder.

deployedOnlyboolean

When true, only return workflows that have been deployed. Useful for listing workflows available for API execution.

limitinteger

Maximum number of workflows to return per page. Must be between 1 and 100.

cursorstring

Pagination cursor returned from a previous request's nextCursor field. Omit for the first page.

Response

A paginated list of workflows.

nextCursorstring nullable

Cursor for fetching the next page of results. null when there are no more results.

Example response

{
  "data": [
    {
      "id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
      "name": "Customer Support Agent",
      "description": "Routes incoming support tickets and drafts responses",
      "folderId": "8a4c2e6b-0d1f-4b3a-9c5e-7f2d8b4a6c91",
      "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",
      "isDeployed": true,
      "deployedAt": "2025-06-15T10:30:00Z",
      "runCount": 142,
      "lastRunAt": "2025-06-20T14:15:22Z",
      "createdAt": "2025-01-10T09:00:00Z",
      "updatedAt": "2025-06-18T16:45:00Z"
    }
  ],
  "limits": {
    "workflowExecutionRateLimit": {
      "sync": {
        "requestsPerMinute": 60,
        "maxBurst": 10,
        "remaining": 59,
        "resetAt": "2025-06-20T14:16:00Z"
      },
      "async": {
        "requestsPerMinute": 60,
        "maxBurst": 10,
        "remaining": 59,
        "resetAt": "2025-06-20T14:16:00Z"
      }
    },
    "usage": {
      "currentPeriodCost": 1.25,
      "limit": 50,
      "plan": "pro"
    }
  }
}