---
title: "Get all leads"
method: GET
path: "/{sub_domain}/api/leads"
tags: ["Leads"]
---

# Get all leads

`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`

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](https://td.commpeak.link/Readme-dialer-api-docs). 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`

## Path parameters

- `sub_domain` string, required: Dialer Name (subdomain)

## Response `200`

Successful Response

- LeadsListResponse
  - `leads` LeadItem[], required
    - `id` integer, nullable: Lead ID.
    - `lead_file_id` integer, nullable: Lead file ID.
    - `api_user_id` integer, nullable: API user ID.
    - `first_name` string, nullable: First name.
    - `last_name` string, nullable: Last name.
    - `phone` string, nullable: Phone.
    - `phone_normalized` string, nullable: Phone normalized.
    - `country_id` integer, nullable: Country ID.
    - `timezone_id` integer, nullable: Timezone ID.
    - `support_site` string, nullable: Support site.
    - `purchase_site` string, nullable: Purchase site.
    - `purchase_amount` integer, nullable: Purchase amount.
    - `is_deleted` integer, nullable: Is deleted (1 - deleted, 0 - active).
    - `is_do_not_call` integer, nullable: Is do not call.
    - `is_locked` integer, nullable: Is locked (1 - in call, 0 - available).
    - `hlr` integer, nullable: HLR.
    - `created_at` string, nullable: Created at.
    - `updated_at` string, nullable: Updated at.
    - `customFields` object, nullable: Custom field name/value pairs.
  - `total_leads` integer, nullable: Total number of leads in the response.

## Other responses

- `404`: Not Found
- `422`: Validation Error
- `500`: Internal Server Error

---

[API](https://skmtc.dev/commpeak/apis/commpeak-dialer-api.md) - [All operations](https://skmtc.dev/commpeak/apis/commpeak-dialer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/commpeak/apis/commpeak-dialer-api/revisions/18c5edc07544?raw)
