GET

Get Workflow

Retrieves the full configuration of a single Workflow.

GEThttps://api.vantaxai.com/v1/workflows/{workflow_id}

Headers

Authorizationstringrequired
Bearer authentication with your secret API key.
example: Bearer vx_live_3fa9c2…

Path Parameters

workflow_idstringrequired
The Workflow's unique identifier.
example: wf_4c81a0

Request

curl -X GET https://api.vantaxai.com/v1/workflows/wf_4c81a0 \
  -H "Authorization: Bearer vx_live_3fa9c2..."

const res = await fetch(
  "https://api.vantaxai.com/v1/workflows/wf_4c81a0",
  {
  method: "GET",
  headers: {
    Authorization: "Bearer vx_live_3fa9c2...",
  },
  }
);
const { data } = await res.json();

import { Vantax } from "@vantax/sdk";

const vantax = new Vantax({ apiKey: process.env.VANTAX_API_KEY! });
// GET /v1/workflows/{workflow_id}
const result = await vantax.request("GET", "/v1/workflows/{workflow_id}");

from vantax import Vantax

vantax = Vantax(api_key=os.environ["VANTAX_API_KEY"])
# GET /v1/workflows/{workflow_id}
result = vantax.request("GET", "/v1/workflows/{workflow_id}")

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",
    "updated_at": "2026-02-02T08:12:00Z"
  }
}

{
  "success": false,
  "message": "Workflow not found"
}