Skip to main content
GET
/
v1
/
workflows
List Workflows
curl --request GET \
  --url https://api.example.com/v1/workflows \
  --header 'x-api-key: <api-key>'
{
  "items": [
    {
      "name": "<string>",
      "organization_id": "<string>",
      "webhook_url": "<string>",
      "id": "<string>",
      "unique_name": "<string>",
      "origin_template": "<string>",
      "delegation_end_strategy": "return-to-start",
      "environment_id": "<string>",
      "sub_agents_continuous_thread": true,
      "deployment_type": "serverless",
      "created_by_prompt": "<string>",
      "prompts": [],
      "is_latest": false,
      "has_pending_changes": false,
      "deep_planning": false,
      "enforce_deep_planning": false,
      "connectivity_details": {},
      "framework": "agno",
      "description": "",
      "tools": [],
      "icon": "🚀",
      "avatar": "male-avatar",
      "source_nodes": [],
      "attached_tools": [],
      "access_scope": "personal",
      "instructions": {
        "role": [],
        "goal": [],
        "general": ""
      },
      "oas": {},
      "graph": [],
      "llm_settings": [],
      "status": "ACTIVE",
      "knowledge_bases": [],
      "version": 1,
      "created_by": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "type": "manager",
      "delegation_type": "router",
      "delegation_memory_strategy": "summarization",
      "is_ai_employee": false,
      "using_nemo": false,
      "deletable": true,
      "model_provider": "anthropic",
      "model_name": "claude-sonnet-4-6",
      "llm_reasoning_effort": "medium",
      "llm_api_base": "<string>",
      "output_format": "markdown",
      "voice_id": "<string>",
      "output_schema": {},
      "llm_credentials_key": "<string>",
      "llm_credentials_key_type": "xpander",
      "llm_credentials": {
        "name": "<string>",
        "value": "<string>",
        "description": "<string>"
      },
      "llm_extra_headers": {},
      "expected_output": "",
      "agno_settings": {
        "session_storage": true,
        "learning": false,
        "agent_memories": false,
        "agentic_culture": false,
        "user_memories": false,
        "agentic_memory": false,
        "session_summaries": false,
        "num_history_runs": 10,
        "max_tool_calls_from_history": 0,
        "tool_call_limit": 0,
        "coordinate_mode": true,
        "pii_detection_enabled": false,
        "pii_detection_mask": true,
        "prompt_injection_detection_enabled": false,
        "openai_moderation_enabled": false,
        "reasoning_tools_enabled": false,
        "tool_calls_compression": {
          "enabled": false,
          "instructions": "",
          "threshold": 3
        },
        "max_plan_retries": 15,
        "plan_retry_strategy": "tiered",
        "memory_strategy": "disabled"
      },
      "on_prem_event_streaming": true,
      "prompts_caching_enabled": false,
      "is_supervised": false,
      "orchestration_nodes": [],
      "notification_settings": {},
      "task_level_strategies": {
        "retry_strategy": {
          "enabled": false,
          "max_retries": 3
        },
        "iterative_strategy": {
          "enabled": false,
          "max_iterations": 3,
          "end_condition": {
            "type": "regex",
            "term": "<string>",
            "group_id": "<string>",
            "path": "<string>",
            "value": null
          }
        },
        "stop_strategy": {
          "enabled": false,
          "stop_on_failure": true,
          "stop_on_condition": {
            "type": "regex",
            "term": "<string>",
            "group_id": "<string>",
            "path": "<string>",
            "value": null
          }
        },
        "max_runs_per_day": 123,
        "agentic_context_enabled": false,
        "duplication_prevention": {
          "selectors": [
            "<string>"
          ],
          "enabled": false,
          "ttl_minutes": 10
        }
      },
      "use_oidc_pre_auth": false,
      "pre_auth_audiences": [],
      "use_oidc_pre_auth_token_for_llm": false,
      "oidc_pre_auth_token_llm_audience": "<string>",
      "oidc_pre_auth_token_mcp_audience": "<string>"
    }
  ],
  "total": 123,
  "page": 123,
  "per_page": 123,
  "total_pages": 123
}
Retrieve a paginated list of workflows in your organization. Workflows are a visual orchestration layer for your AI agents — deterministic, multi-step pipelines where you arrange agents, tools, and logic nodes on a canvas to control execution order, branching, and data flow. In the API, workflows are represented as agents with type: "orchestration". Every node in a workflow is powered by an AI agent, so the execution path is predictable but the intelligence at each step is adaptive.

​
Query Parameters

​
page
integer
default:1
Page number (starting from 1)
​
per_page
integer
default:20
Items per page (maximum 50)

​
Response

​
items
array
Array of workflow objects
​
total
integer
Total number of workflows across all pages
​
page
integer
Current page number
​
per_page
integer
Number of items per page
​
total_pages
integer
Total number of pages available

​
Example Request

curl -X GET -H "x-api-key: <your-api-key>" \
  "https://api.xpander.ai/v1/workflows?page=1&per_page=10"

​
Notes

  • Only workflows (type: orchestration) are returned — regular agents are excluded
  • Results are filtered by API key permissions
  • Use pagination to handle large result sets
  • See the Workflows user guide for details on the visual canvas and node types

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Query Parameters

​
page
integer
default:1

Page number (starting from 1)

Required range: x >= 1
​
per_page
integer
default:10

Items per page (max 50)

Required range: 1 <= x <= 50

Response

Successful Response

​
items
WorkflowResponse · object[]
required
​
total
integer
required
​
page
integer
required
​
per_page
integer
required
​
total_pages
integer
required