Skip to main content
GET
Campaign connected contacts
Use this endpoint to retrieve a paginated list of contacts from every Audience and Segment currently connected to a campaign (via Attach Campaign Sources).

Endpoint

GET /campaign/contacts-list Authentication: Required (workspace auth)

Query Parameters

Response

Behavior

  • Expands each source connected to the campaign into its contacts — a campaign connected to 2 audiences of 100 contacts each returns 200 rows.
  • One row per (source, contact) pair: a contact present in more than one connected source appears once per source.
  • Only sources with an active link (not detached) are included.
  • Call-related fields (lead_status, attempt, call_status, duration, disposition, last_attempt, modified_by) are left-joined from the dial queue and stay blank until the contact is dialed.

Error Cases

Example cURL

Headers

token
string
required

API token for authentication

Query Parameters

campaign_id
integer
required

Campaign identifier

page
integer

Page number (default: 1)

limit
integer

Records per page (default: 10)

mobile_no
string

Partial mobile number search (LIKE)

Response

Connected contacts retrieved successfully

datalist
object[]
pagination
object