Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB
Workflow Variables

List workflow variables

Lists variables for an automation workflow. Requires a USER API key.

get/public/v1/workflows/{workflowId}/variables

Path parameters

workflowIdnumber nullable
Example:501

Query parameters

filterTextstring
Example:customer
boolean
OR
string
Example:example

Response

Paginated variables

countnumber
pageSizenumber required
pageNumnumber
totalPagesnumber
cursornumber
paginationType'offset' | 'cursor'

Example response

{
  "count": 1,
  "pageSize": 1,
  "pageNum": 1,
  "totalPages": 1,
  "cursor": 1,
  "results": [
    {
      "id": 123,
      "name": "customer_name",
      "description": "example",
      "status": "ACTIVE",
      "createdAt": "2024-01-01T12:00:00Z",
      "updatedAt": "2024-01-01T12:00:00Z",
      "assistantId": "example",
      "automationId": 1,
      "pattern": "example",
      "defaultValue": "example"
    }
  ],
  "paginationType": "offset",
  "nextCursor": "example"
}