Skip to main content
GET
/
processes
/
list
/
{projectId}
curl --request GET \
  --url https://crm.uservox.ai/api/v1/processes/list/64abc123def456789 \
  --header 'Authorization: Bearer <your-api-key>'

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

Documentation Index

Fetch the complete documentation index at: https://docs.uservox.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Path Parameters

​
projectId
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

​
success
boolean
Indicates if the request was successful
​
processes
array
Array of process objects, sorted by creation date (newest first)
​
count
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>'

​
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"
}