Skip to main content
GET
Query Leads

Query Parameters

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

Response

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