Workflows

The Workflow feature is temporarily on hold and will resume shortly. Existing workflows remain stored and readable through the endpoints below, but POST /v1/workflows, PATCH /v1/workflows/{id}, DELETE /v1/workflows/{id}, POST /v1/workflows/{id}/run, and POST /v1/workflows/schedule currently return 403 Forbidden and perform no action. The CRM, email, SMS, calendar, webhook, and reporting integrations Workflows used are unaffected and remain available through their own areas of the API.

Workflows let you orchestrate actions and call flows for your organization.

Authentication & scope

Header: X-API-Key: YOUR_API_KEY
Read operations: workflows:read
Write operations: workflows:write
Use API Reference for Try-it on every workflow endpoint.

`POST /v1/workflows` (on hold)

Creating workflows is on hold. This endpoint currently always returns 403 Forbidden and creates nothing.

`403 Forbidden`

{
  "success": false,
  "error": {
    "code": "workflow_on_hold",
    "message": "The Workflow feature is temporarily on hold and will resume shortly. Existing workflows remain viewable but cannot be created, edited, duplicated, or run.",
    "reason": "The Workflow feature is temporarily on hold and will resume shortly. Existing workflows remain viewable but cannot be created, edited, duplicated, or run."
  },
  "meta": {
    "requestId": "req_01hxyz",
    "timestamp": "2026-09-17T10:00:00.000Z",
    "version": "v1"
  }
}

`POST /v1/workflows/{id}/run` (on hold)

Manually triggering a workflow is on hold. This endpoint currently always returns 403 Forbidden and starts no execution.

`403 Forbidden`

Same error shape as POST /v1/workflows above.

`GET /v1/workflows/jobs/{jobId}`

Returns scheduler job status. Still available for reviewing the history of workflows that ran before the hold.

curl -X GET "https://api.indigenius.ai/v1/workflows/jobs/job_01hxyz" \
  -H "X-API-Key: YOUR_API_KEY"

const jobId = 'job_01hxyz';
const response = await fetch(
  `https://api.indigenius.ai/v1/workflows/jobs/${jobId}`,
  {
    headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY },
  },
);
console.log(await response.json());

import requests
job_id = "job_01hxyz"
response = requests.get(
    f"https://api.indigenius.ai/v1/workflows/jobs/{job_id}",
    headers={"X-API-Key": "YOUR_API_KEY"},
    timeout=30,
)
print(response.status_code)
print(response.json())

Common status codes

200 success
403 missing workflows:read
404 job not found
500 server error

`POST /v1/workflows/schedule` (on hold)

Scheduling a workflow is on hold. This endpoint currently always returns 403 Forbidden and schedules nothing.

`403 Forbidden`

Same error shape as POST /v1/workflows above.

`GET /v1/workflows`

Returns paginated workflows for the organization. Requires workflows:read. Still available — this is how you list existing (read-only) workflows.

curl -X GET "https://api.indigenius.ai/v1/workflows?page=1&pageSize=10" \
  -H "X-API-Key: YOUR_API_KEY"

const response = await fetch(
  'https://api.indigenius.ai/v1/workflows?page=1&pageSize=10',
  {
    headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY },
  },
);
console.log(await response.json());

import requests
response = requests.get(
    "https://api.indigenius.ai/v1/workflows",
    headers={"X-API-Key": "YOUR_API_KEY"},
    params={"page": 1, "pageSize": 10},
    timeout=30,
)
print(response.status_code)
print(response.json())

This endpoint has no message — data is the pagination object itself:

{
  "success": true,
  "data": {
    "currentPage": 1,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPrevPage": false,
    "nextPage": null,
    "prevPage": null,
    "record": [
      {
        "id": "665e4a34c65bb95f2f2d72e1",
        "title": "Lead followup workflow",
        "status": 1,
        "createdAt": "2026-06-02T10:00:00.000Z",
        "updatedAt": "2026-06-02T10:00:00.000Z",
        "crm_module": false,
        "agent_module": true,
        "calendar_module": false,
        "email_module": true,
        "sms_module": false,
        "report_module": false,
        "webhook_module": true,
        "end_call_module": false,
        "enabled": true,
        "scheduled_date": null,
        "timezone": null,
        "structure": {}
      }
    ]
  },
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

The *_module booleans tell you which modules are attached without needing to inspect structure.

Common status codes

200 success
403 missing workflows:read
500 server error

`GET /v1/workflows/{id}`

Returns workflow details, including the attached module configuration (CRM, agent, email, SMS, webhook, report, calendar, end call). Requires workflows:read. Still available for reading an existing workflow.

curl -X GET "https://api.indigenius.ai/v1/workflows/WORKFLOW_ID" \
  -H "X-API-Key: YOUR_API_KEY"

const workflowId = 'WORKFLOW_ID';
const response = await fetch(
  `https://api.indigenius.ai/v1/workflows/${workflowId}`,
  {
    headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY },
  },
);
console.log(await response.json());

import requests
workflow_id = "WORKFLOW_ID"
response = requests.get(
    f"https://api.indigenius.ai/v1/workflows/{workflow_id}",
    headers={"X-API-Key": "YOUR_API_KEY"},
    timeout=30,
)
print(response.status_code)
print(response.json())

`200 OK`

{
  "success": true,
  "message": "Workflow fetched",
  "data": {
    "id": "665e4a34c65bb95f2f2d72e1",
    "title": "Lead followup workflow",
    "structure": {},
    "enabled": true
  },
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

Common status codes

200 success
403 missing workflows:read
404 workflow not found
500 server error

`PATCH /v1/workflows/{id}` (on hold)

Editing a workflow is on hold. This endpoint currently always returns 403 Forbidden and changes nothing.

`403 Forbidden`

Same error shape as POST /v1/workflows above.

`DELETE /v1/workflows/{id}` (on hold)

Deleting a workflow is on hold, so that existing workflows remain available for viewing. This endpoint currently always returns 403 Forbidden and deletes nothing.

`403 Forbidden`

Same error shape as POST /v1/workflows above.

`POST /v1/workflows/{id}/cancel`

Cancels a queued, waiting, or active workflow run by removing its pending jobs from the queue. Requires workflows:write. Still available, in case a run started before the hold is still in flight.

curl -X POST "https://api.indigenius.ai/v1/workflows/WORKFLOW_ID/cancel" \
  -H "X-API-Key: YOUR_API_KEY"

const workflowId = 'WORKFLOW_ID';
const response = await fetch(
  `https://api.indigenius.ai/v1/workflows/${workflowId}/cancel`,
  {
    method: 'POST',
    headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY },
  },
);
console.log(await response.json());

import requests
workflow_id = "WORKFLOW_ID"
response = requests.post(
    f"https://api.indigenius.ai/v1/workflows/{workflow_id}/cancel",
    headers={"X-API-Key": "YOUR_API_KEY"},
    timeout=30,
)
print(response.status_code)
print(response.json())

`200 OK`

{
  "success": true,
  "message": "Workflow canceled successfully",
  "data": null,
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

Common status codes

200 canceled
403 missing workflows:write
404 workflow not found
500 server error

`GET /v1/workflows/{id}/jobs`

Returns all scheduler jobs (completed, active, waiting, failed, paused, delayed) linked to a workflow, with an aggregate count per state. Requires workflows:read. Still available for reviewing past run history.

curl -X GET "https://api.indigenius.ai/v1/workflows/WORKFLOW_ID/jobs" \
  -H "X-API-Key: YOUR_API_KEY"

const workflowId = 'WORKFLOW_ID';
const response = await fetch(
  `https://api.indigenius.ai/v1/workflows/${workflowId}/jobs`,
  {
    headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY },
  },
);
console.log(await response.json());

import requests
workflow_id = "WORKFLOW_ID"
response = requests.get(
    f"https://api.indigenius.ai/v1/workflows/{workflow_id}/jobs",
    headers={"X-API-Key": "YOUR_API_KEY"},
    timeout=30,
)
print(response.status_code)
print(response.json())

`200 OK`

{
  "success": true,
  "message": "Workflow jobs fetched successfully",
  "data": [
    {
      "id": "job_01hxyz",
      "status": "completed"
    },
    {
      "id": "job_01hyza",
      "status": "active"
    }
  ],
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

Common status codes

200 success
403 missing workflows:read
500 server error

`GET /v1/workflows/{id}/summary`

Returns a high-level execution summary (total contacts processed, completed, failed) for the workflow. Requires workflows:read. Still available for reviewing history.

curl -X GET "https://api.indigenius.ai/v1/workflows/WORKFLOW_ID/summary" \
  -H "X-API-Key: YOUR_API_KEY"

const workflowId = 'WORKFLOW_ID';
const response = await fetch(
  `https://api.indigenius.ai/v1/workflows/${workflowId}/summary`,
  {
    headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY },
  },
);
console.log(await response.json());

import requests
workflow_id = "WORKFLOW_ID"
response = requests.get(
    f"https://api.indigenius.ai/v1/workflows/{workflow_id}/summary",
    headers={"X-API-Key": "YOUR_API_KEY"},
    timeout=30,
)
print(response.status_code)
print(response.json())

`200 OK`

{
  "success": true,
  "message": "Workflow summary fetched successfully",
  "data": {
    "totalContacts": 120,
    "completed": 98,
    "failed": 22
  },
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

Common status codes

200 success
403 missing workflows:read
404 workflow not found
500 server error

`GET /v1/workflows/{id}/summary/report`

Returns a detailed per-contact report for every run of the workflow, including call, email, SMS, and calendar module outcomes. Requires workflows:read. Still available for reviewing history.

curl -X GET "https://api.indigenius.ai/v1/workflows/WORKFLOW_ID/summary/report" \
  -H "X-API-Key: YOUR_API_KEY"

const workflowId = 'WORKFLOW_ID';
const response = await fetch(
  `https://api.indigenius.ai/v1/workflows/${workflowId}/summary/report`,
  {
    headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY },
  },
);
console.log(await response.json());

import requests
workflow_id = "WORKFLOW_ID"
response = requests.get(
    f"https://api.indigenius.ai/v1/workflows/{workflow_id}/summary/report",
    headers={"X-API-Key": "YOUR_API_KEY"},
    timeout=30,
)
print(response.status_code)
print(response.json())

`200 OK`

{
  "success": true,
  "message": "Workflow report fetched successfully",
  "data": {
    "id": "665e4a34c65bb95f2f2d72e1",
    "report": [
      {
        "contact": "+14155552671",
        "status": "completed"
      }
    ]
  },
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

Common status codes

200 success
403 missing workflows:read
404 workflow not found
500 server error

`GET /v1/workflows/{id}/summary/timeline`

Returns a chronological list of execution events (started, module executed, contact completed, etc.) for the workflow. Requires workflows:read. Still available for reviewing history.

curl -X GET "https://api.indigenius.ai/v1/workflows/WORKFLOW_ID/summary/timeline" \
  -H "X-API-Key: YOUR_API_KEY"

const workflowId = 'WORKFLOW_ID';
const response = await fetch(
  `https://api.indigenius.ai/v1/workflows/${workflowId}/summary/timeline`,
  {
    headers: { 'X-API-Key': process.env.INDIGENIUS_API_KEY },
  },
);
console.log(await response.json());

import requests
workflow_id = "WORKFLOW_ID"
response = requests.get(
    f"https://api.indigenius.ai/v1/workflows/{workflow_id}/summary/timeline",
    headers={"X-API-Key": "YOUR_API_KEY"},
    timeout=30,
)
print(response.status_code)
print(response.json())

`200 OK`

{
  "success": true,
  "message": "Workflow timeline fetched successfully",
  "data": [
    {
      "at": "2026-06-02T10:00:00.000Z",
      "event": "workflow.started"
    },
    {
      "at": "2026-06-02T10:01:22.000Z",
      "event": "workflow.completed"
    }
  ],
  "meta": {
    "requestId": "f3c9b29a-9f4d-4b71-8b3b-2cb77f4e9cf1",
    "timestamp": "2026-06-02T10:30:45.123Z",
    "version": "v1"
  }
}

Common status codes

200 success
403 missing workflows:read
404 workflow not found
500 server error

Recommended flow

There is currently no create/run/schedule flow to follow while Workflows is on hold. Use GET /v1/workflows and GET /v1/workflows/{id} to read existing workflows, and the jobs/summary/summary/report/summary/timeline endpoints to review history from before the hold. If you need call, email, SMS, calendar, webhook, or CRM automation in the meantime, use those integrations directly through their own areas of the API rather than through a workflow.

Getting Started

Core APIs

Platform APIs

Workflows

Workflows

Authentication & scope

`POST /v1/workflows` (on hold)

`403 Forbidden`

`POST /v1/workflows/{id}/run` (on hold)

`403 Forbidden`

`GET /v1/workflows/jobs/{jobId}`

Common status codes

`POST /v1/workflows/schedule` (on hold)

`403 Forbidden`

`GET /v1/workflows`

Common status codes

`GET /v1/workflows/{id}`

`200 OK`

Common status codes

`PATCH /v1/workflows/{id}` (on hold)

`403 Forbidden`

`DELETE /v1/workflows/{id}` (on hold)

`403 Forbidden`

`POST /v1/workflows/{id}/cancel`

`200 OK`

Common status codes

`GET /v1/workflows/{id}/jobs`

`200 OK`

Common status codes

`GET /v1/workflows/{id}/summary`

`200 OK`

Common status codes

`GET /v1/workflows/{id}/summary/report`

`200 OK`

Common status codes

`GET /v1/workflows/{id}/summary/timeline`

`200 OK`

Common status codes

Recommended flow

​Workflows

​Authentication & scope

​POST /v1/workflows (on hold)

​403 Forbidden

​POST /v1/workflows/{id}/run (on hold)

​403 Forbidden

​GET /v1/workflows/jobs/{jobId}

​Common status codes

​POST /v1/workflows/schedule (on hold)

​403 Forbidden

​GET /v1/workflows

​Common status codes

​GET /v1/workflows/{id}

​200 OK

​Common status codes

​PATCH /v1/workflows/{id} (on hold)

​403 Forbidden

​DELETE /v1/workflows/{id} (on hold)

​403 Forbidden

​POST /v1/workflows/{id}/cancel

​200 OK

​Common status codes

​GET /v1/workflows/{id}/jobs

​200 OK

​Common status codes

​GET /v1/workflows/{id}/summary

​200 OK

​Common status codes

​GET /v1/workflows/{id}/summary/report

​200 OK

​Common status codes

​GET /v1/workflows/{id}/summary/timeline

​200 OK

​Common status codes

​Recommended flow

Workflows

Authentication & scope

`POST /v1/workflows` (on hold)

`403 Forbidden`

`POST /v1/workflows/{id}/run` (on hold)

`403 Forbidden`

`GET /v1/workflows/jobs/{jobId}`

Common status codes

`POST /v1/workflows/schedule` (on hold)

`403 Forbidden`

`GET /v1/workflows`

Common status codes

`GET /v1/workflows/{id}`

`200 OK`

Common status codes

`PATCH /v1/workflows/{id}` (on hold)

`403 Forbidden`

`DELETE /v1/workflows/{id}` (on hold)

`403 Forbidden`

`POST /v1/workflows/{id}/cancel`

`200 OK`

Common status codes

`GET /v1/workflows/{id}/jobs`

`200 OK`

Common status codes

`GET /v1/workflows/{id}/summary`

`200 OK`

Common status codes

`GET /v1/workflows/{id}/summary/report`

`200 OK`

Common status codes

`GET /v1/workflows/{id}/summary/timeline`

`200 OK`

Common status codes

Recommended flow