Leads

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

put/{sub_domain}/api/leads/extended-data

Request

  • Base URL
    https://api.commpeak.com/dialer
  • URL
    https://api.commpeak.com/dialer/{sub_domain}/api/leads/extended-data
  • Auth
    API key in header Authorization

Path parameters

sub_domainstring required

Dialer Name (subdomain)

Request body

idinteger[] nullable

Lead IDs.

first_namestring[] nullable

Match by first name(s).

limitstring nullable

Limit and offset as "limit;offset".

created_atstring nullable

Filter by the date the lead was created.

updated_atstring nullable

Filter by lead updated_at.

campaign_updated_atstring nullable

Filter by campaign lead updated_at.

global_updated_atstring nullable

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

Response

Successful Response

total_leadsinteger nullable

Total number of leads in the response.

Changes

No recorded changes to this operation across all 1 revision of this API.