Skip to main content
GET /workflows/:id Fetch one agent’s full tree: base config, funnel statuses, custom fields, and custom tools.

Path Parameters

ParameterTypeRequiredDescription
idstring (uuid)YesAgent ID

Responses

200 — Successful response

{
  "workflow": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Sales Agent",
    "description": "Qualifies inbound leads and books demo calls",
    "goal_type": "appointment",
    "global_prompt": "You are Iris, a friendly sales rep for Acme...",
    "is_paused": false,
    "is_active": true,
    "timezone": "America/Santiago",
    "created_at": "2026-01-15T09:00:00Z",
    "updated_at": "2026-02-01T12:00:00Z",
    "statuses": [
      { "key": "new", "label": "New", "category": "active", "is_initial": true, "is_terminal": false, "sort_order": 0 },
      { "key": "won", "label": "Won", "category": "won", "is_initial": false, "is_terminal": true, "sort_order": 1 }
    ],
    "fields": [
      { "key": "budget", "label": "Budget", "type": "number", "required": false }
    ],
    "tools": [
      { "name": "check_availability", "is_active": true }
    ]
  }
}

Response Fields — Workflow

FieldTypeDescription
idstring (uuid)Agent identifier
namestringAgent name
descriptionstring | nullAgent description
goal_typestringSee Create Agent for valid values
global_promptstringThe base prompt
is_pausedbooleanWhether the agent is currently paused
is_activebooleanWhether the agent is active (vs. archived)
timezonestringIANA timezone used for cadence scheduling
statusesarrayFunnel statuses, ordered by sort_order
fieldsarrayCustom lead fields this agent collects
toolsarrayCustom tools this agent can call, with name and is_active only — see List Workflow Tools for full detail

401 — Authentication error

See Authentication.

404 — Not found

{
  "error": "Not found",
  "message": "Workflow not found"
}

500 — Internal server error

Last modified on July 10, 2026