Endpoint
Query Parameters
integer
default:"20"
Maximum number of leads to return per page. Accepts values between
1 and 100.string
Opaque pagination cursor returned in the previous response’s
pagination.next_cursor field. Omit this parameter to start from the first page.string
Filter leads by their current status. Accepted values:
new, in_conversation, qualified, assigned, closed, lost.string
Filter leads by AI-detected purchase intent. Accepted values:
purchase_30_days, purchase_90_days, browsing, unknown.string
Filter leads by the channel through which they first entered DeltaLead. Accepted values:
whatsapp, facebook, instagram, mercadolibre, web_form, email, phone.integer
Return only leads with a score greater than or equal to this value. Range:
0–100.integer
Return only leads with a score less than or equal to this value. Range:
0–100.string
Return only leads created on or after this timestamp. Must be an ISO 8601 date-time string, e.g.
2024-01-15T00:00:00Z.string
Return only leads created on or before this timestamp. Must be an ISO 8601 date-time string, e.g.
2024-01-31T23:59:59Z.Example Request
cURL
Response
A successful request returns HTTP200 OK with a JSON object containing a data array of lead objects and a pagination object for cursor-based navigation.
Example response
Response Fields
array
Array of lead objects matching the applied filters. See Get Lead for the full description of each field.
string
Unique identifier for the lead, prefixed with
lead_.string
Full name of the lead as captured from the source channel.
string
Lead’s phone number in E.164 format, e.g.
+5491155551234.string | null
Lead’s email address.
null if not provided.string
The channel through which the lead first contacted your dealership. One of
whatsapp, facebook, instagram, mercadolibre, web_form, email, phone.string | null
Vehicle model or description the lead expressed interest in.
null if not yet identified.integer
AI-generated lead quality score from
0 (cold) to 100 (highly qualified).string
Detected purchase intent. One of
purchase_30_days, purchase_90_days, browsing, unknown.string
Current lifecycle status of the lead. One of
new, in_conversation, qualified, assigned, closed, lost.string | null
User ID of the sales advisor this lead is assigned to.
null if unassigned.string
ISO 8601 timestamp of when the lead was first captured.
string
ISO 8601 timestamp of the most recent field update.
string
ISO 8601 timestamp of the last message, call, or interaction recorded for this lead.
string
Unique identifier of the DeltaLead organization (dealership) that owns this lead.
object
Cursor-based pagination metadata.
integer
Total number of leads matching the applied filters (across all pages).
integer
Number of results returned in this page.
boolean
true if additional pages of results exist.string | null
Pass this value as the
cursor query parameter to fetch the next page. null when has_more is false.