Get all leads

Retrieve the leads in your account, most recent first.

When to use. Browse, export, or sync your lead records into your own systems. For leads enriched with campaign-level details such as status and call counts, use PUT /leads/extended-data.

Parameters. Filter, order, limit and select fields by any response field. See Core API Concepts. Use the fields query parameter with a semicolon-separated list to return only the fields you need, including customFields. Deleted leads are excluded unless you pass is_deleted. When no limit is given, up to 500 leads are returned.

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

Example. GET /api/leads/limit/50;0

get/{sub_domain}/api/leads

Request

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

Path parameters

sub_domainstring required

Dialer Name (subdomain)

Response

Successful Response

total_leadsinteger nullable

Total number of leads in the response.

Example response

{
  "leads": [
    {
      "address1": "1st Avenue 111",
      "city": "New York",
      "country_id": 840,
      "created_at": "2024-08-13 18:22:46",
      "customFields": {
        "Age": "",
        "NoteA": "",
        "Street": ""
      },
      "first_name": "John",
      "hlr": 0,
      "id": 594652,
      "is_deleted": 0,
      "is_do_not_call": 0,
      "is_locked": 0,
      "last_name": "Doe",
      "lead_file_id": 1609,
      "phone": "12125551234",
      "phone_normalized": "12125551234",
      "purchase_amount": 0,
      "purchase_site": "DemoStore",
      "support_site": "DemoSupport",
      "timezone_id": 274,
      "updated_at": "2024-08-13 18:22:50"
    }
  ]
}

Changes

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