Vantax AIDocs
GET

List Workflows

Returns a paginated list of Workflows in your sub-account.

GEThttps://api.vantaxai.com/v1/workflows

Workflows are returned newest-first. Use the `limit` and `starting_after` cursor parameters to page through large collections. Each Workflow includes its trigger and the ordered list of steps that run when it fires.

Headers

  • Authorizationstringrequired

    Bearer authentication with your secret API key.

    example: Bearer vx_live_3fa9c2…

Query Parameters

  • sub_account_idstringrequired

    The sub-account to list Workflows for.

    example: sub_8a1f4c2e

  • limitintegeroptional

    Number of records to return (1–100). Defaults to 20.

    example: 20

  • starting_afterstringoptional

    Cursor for pagination — a Workflow id to start after.

    example: wf_4c81a0

  • is_activebooleanoptional

    Filter by active state.

    example: true

Request

curl https://api.vantaxai.com/v1/workflows?sub_account_id=sub_8a1f4c2e \
  -H "Authorization: Bearer vx_live_3fa9c2..."

Response

{
  "success": true,
  "data": [
    {
      "id": "wf_4c81a0",
      "name": "New Lead Follow-up",
      "description": "Texts new contacts and books an intro call",
      "trigger": {
        "type": "contact.created",
        "config": { "source": "website" }
      },
      "steps": [
        {
          "id": "step_send_sms",
          "type": "send_sms",
          "config": { "agent_id": "agt_3d9b21", "template": "Welcome! Reply to book a call." },
          "next": "step_add_tag"
        },
        {
          "id": "step_add_tag",
          "type": "add_tag",
          "config": { "tag_id": "tag_9f02" },
          "next": null
        }
      ],
      "is_active": true,
      "sub_account_id": "sub_8a1f4c2e",
      "created_at": "2026-01-14T10:30:00Z"
    }
  ],
  "pagination": {
    "total": 6,
    "limit": 20,
    "has_more": false
  }
}