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

# Get campaign leads

`GET /{sub_domain}/api/campaign-leads`

## Request

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

Retrieve campaign leads with all their details.

**When to use.** List the leads assigned to your campaigns, optionally narrowed to a specific campaign or status. To change a campaign lead rather than read it, use `PUT /campaign-leads/update-campaign-leads`.

**Filtering and shape.** Filter, order, limit and select fields by any response field. See [Core API Concepts](https://td.commpeak.link/Readme-dialer-api-docs). By default only active (not deleted) records are returned, and the result is capped at 500 rows unless you pass your own `limit`.

**Returns.** `{ "campaignLeads": [ ... ], "total_leads": N }`, where `total_leads` is the number of records matching your filter.

**Example.** `GET /api/campaign-leads/campaign_id/42/limit/50;0`

## Path parameters

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

## Response `200`

Successful Response

- CampaignLeadsListResponse
  - `campaignLeads` CampaignLeadItem[], required
    - `lead_id` integer, nullable: Lead ID.
    - `campaign_id` integer, nullable: Campaign ID.
    - `status_id` integer, nullable: Campaign lead status ID.
    - `created_at` string, nullable: Created at.
    - `updated_at` string, nullable: Updated at.
    - `assigned_user_id` integer, nullable: Assigned user ID.
    - `assigned_at` string, nullable: Assigned at.
    - `call_after` string, nullable: Do not call before this time (freeze).
    - `weight` integer, nullable: Dialing weight (1 to 65536).
    - `is_deleted` integer, nullable: Is deleted (1 = deleted, 0 = active).
    - `calls_count` integer, nullable: Number of calls made to this campaign lead.
  - `total_leads` integer, nullable: Total number of matching campaign leads.

## 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)