Get extended lead information

Retrieve leads together with their extended campaign information.

When to use. Fetch leads enriched with campaign-level details such as status, call counts, freeze time, campaign name, and reasons a lead is not currently callable. For the basic lead records, use GET /leads.

Request body. A filter object selecting which leads to return. Each key is a lead or campaign-lead field: a scalar matches by equality and an array matches any of the listed values. Special filters:

  • limit: a "limit;offset" string, for example "500;1000". Up to 200 rows are returned by default.
  • Date fields such as created_at, updated_at, campaign_updated_at and global_updated_at accept a "value;operator" expression, and two can be combined with a pipe to select a range, for example "2024-06-01 00:00:00;>|2024-06-30 00:00:00;<". The operator is one of =, !=, <>, <, >, <=, >=, like. A date value sent on its own, with no operator, matches by equality.

An empty body is rejected with 400.

Returns. { "leads": [ ... ], "total_leads": N }.

Example. PUT /api/leads/extended-data with body { "campaign_id": 42, "limit": "50;0" }

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Filter object for the extended-data lookup. Each key is a lead/campaign-lead field; scalars match by equality, arrays with IN (...). limit takes a "count;offset" string. Date fields accept a "value;operator" (optionally pipe-joined) expression. Default limit is 200 rows.

id
array of integers

Lead IDs.

id
first_name
array of strings

Match by first name(s).

first_name
string

Limit and offset as "limit;offset".

string

Filter by the date the lead was created.

string

Filter by lead updated_at.

string

Filter by campaign lead updated_at.

string

Filter by the latest updated_at across the lead or its related campaign leads.

Responses

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json