Skip to main content
GET
https://crm.uservox.ai/api/v1
/
leads
/
query
Query Leads
curl --request GET \
  --url https://crm.uservox.ai/api/v1/leads/query \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {}
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "skip": 123
  }
}

Query Parameters

projectId
string
required
MongoDB ObjectId of the project
processId
string
Filter by process ID
referenceId
string
Filter by reference ID
phone
string
Filter by phone number
email
string
Filter by email address
currentState
string
Filter by current state
lastDisposition
string
Filter by last disposition
limit
number
default:"10"
Maximum number of results (max: 100)
skip
number
default:"0"
Number of results to skip for pagination
includeActivities
boolean
default:"true"
Include activities in response
masked
boolean
default:"false"
Mask phone numbers

Response

success
boolean
Indicates if the request was successful
data
array
Array of lead objects
pagination
object
Pagination information