Get campaign leads
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. 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
Request
- Base URLhttps://api.commpeak.com/dialer
- URLhttps://api.commpeak.com/dialer/{sub_domain}/api/campaign-leads
- AuthAPI key in header Authorization
Path parameters
Dialer Name (subdomain)
Response
Successful Response
Changes
No recorded changes to this operation across all 1 revision of this API.