List Processes

curl --request GET \
  --url https://crm.uservox.ai/api/v1/processes/list/64abc123def456789 \
  --header 'Authorization: Bearer <your-api-key>'

const response = await fetch(
  'https://crm.uservox.ai/api/v1/processes/list/64abc123def456789',
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer <your-api-key>'
    }
  }
);

const data = await response.json();

import requests

url = "https://crm.uservox.ai/api/v1/processes/list/64abc123def456789"
headers = {
    "Authorization": "Bearer <your-api-key>"
}

response = requests.get(url, headers=headers)
data = response.json()

{
  "success": false,
  "error": "projectId is required"
}

{
  "error": "Authorization header missing or invalid format"
}

{
  "success": false,
  "error": "Not authorized to access processes for this project"
}

{
  "success": false,
  "error": "Internal server error"
}

GET

processes

list

{projectId}

curl --request GET \
  --url https://crm.uservox.ai/api/v1/processes/list/64abc123def456789 \
  --header 'Authorization: Bearer <your-api-key>'

const response = await fetch(
  'https://crm.uservox.ai/api/v1/processes/list/64abc123def456789',
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer <your-api-key>'
    }
  }
);

const data = await response.json();

import requests

url = "https://crm.uservox.ai/api/v1/processes/list/64abc123def456789"
headers = {
    "Authorization": "Bearer <your-api-key>"
}

response = requests.get(url, headers=headers)
data = response.json()

{
  "success": false,
  "error": "projectId is required"
}

{
  "error": "Authorization header missing or invalid format"
}

{
  "success": false,
  "error": "Not authorized to access processes for this project"
}

{
  "success": false,
  "error": "Internal server error"
}

Path Parameters

string

required

MongoDB ObjectId of the project to list processes for

Authentication

This endpoint requires a valid API key for the specified project. The API key must be included in the Authorization header as a Bearer token.

Authorization: Bearer <your-api-key>

Authorization

The API key must belong to the project specified in the projectId parameter. If the API key belongs to a different project, the request will be rejected with a 403 Forbidden error.

Response

boolean

Indicates if the request was successful

array

Array of process objects, sorted by creation date (newest first)

Show Process Object Properties

string

Process ID (MongoDB ObjectId)

string

Process title/name

string

Process description

string

Associated project ID

number

Type of process

array

Array of phone numbers used by this process

string

WhatsApp sender ID for this process

number

Active status indicator (1 = active, 0 = inactive)

boolean

Whether the process is currently active

boolean

Whether the process is stateless

string

Starting node ID for the process

array

Array of node objects defining the process flow

array

Array of call window configurations

array

Array of possible dispositions for leads in this process

array

Array of custom actions defined for this process

array

Array of callback configurations

number

Process version number

object

Additional metadata for the process

string

Timezone for the process (e.g., “Asia/Kolkata”)

string

ISO 8601 timestamp of when the process was created

string

ISO 8601 timestamp of when the process was last updated

number

Total number of processes returned

Example Request

curl --request GET \
  --url https://crm.uservox.ai/api/v1/processes/list/64abc123def456789 \
  --header 'Authorization: Bearer <your-api-key>'

const response = await fetch(
  'https://crm.uservox.ai/api/v1/processes/list/64abc123def456789',
  {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer <your-api-key>'
    }
  }
);

const data = await response.json();

import requests

url = "https://crm.uservox.ai/api/v1/processes/list/64abc123def456789"
headers = {
    "Authorization": "Bearer <your-api-key>"
}

response = requests.get(url, headers=headers)
data = response.json()

Example Response

{
  "success": true,
  "processes": [
    {
      "_id": "64def456abc789123",
      "title": "Sales Outreach Process",
      "description": "Automated sales outreach for new leads",
      "projectId": "64abc123def456789",
      "processType": 1,
      "numberPool": ["+919876543210"],
      "whatsappFromId": "1234567890",
      "activeStatus": 1,
      "isActive": true,
      "stateless": false,
      "start": "initial_contact",
      "nodes": [...],
      "callWindows": [...],
      "dispositions": [...],
      "actions": [],
      "callbacks": [],
      "version": 1,
      "metadata": {},
      "timezone": "Asia/Kolkata",
      "createdAt": "2024-03-15T10:30:00.000Z",
      "updatedAt": "2024-03-20T14:45:00.000Z"
    }
  ],
  "count": 1
}

Error Responses

{
  "success": false,
  "error": "projectId is required"
}

{
  "error": "Authorization header missing or invalid format"
}

{
  "success": false,
  "error": "Not authorized to access processes for this project"
}

{
  "success": false,
  "error": "Internal server error"
}

API Documentation

Leads

Activities

Conversations

Analytics

Processes

Path Parameters

Authentication

Authorization

Response

Example Request

Example Response

Error Responses

​Path Parameters

​Authentication

​Authorization

​Response

​Example Request

​Example Response

​Error Responses

Path Parameters

Authentication

Authorization

Response

Example Request

Example Response

Error Responses