Skip to main content
GET
List segment contacts
Use this endpoint to retrieve a paginated list of a segment’s contacts — the materialized contact mapping created when the segment was built, not a live re-evaluation of its filter.

Endpoint

GET /segment/contacts Authentication: Required (workspace auth)

Query Parameters

Response

Behavior

  • Reads the segment’s materialized contact mapping (segment_contacts, status = active) joined to the underlying audience contacts — the exact set a connected campaign would dial. The segment’s filter is not re-evaluated here.
  • Dynamic columns come from the parent audience’s saved input variables (stable order), plus any extra input keys found on this page’s contacts. Phone-number aliases (mobile_no, mobile, phone, phone_no, phone_number) are skipped since mobile_no already has its own column.
  • mobile_no is masked when the workspace’s company has phone number masking enabled.
  • As a side effect, the segment’s cached total_contacts is refreshed to match the live count of materialized contacts if it had drifted.

Error Cases

Example cURL

Headers

token
string
required

API token for authentication

Query Parameters

segment_id
integer
required

Segment identifier

page
integer

Page number (default: 1)

limit
integer

Records per page (default: 10)

Partial mobile number search (LIKE)

Response

Segment contacts retrieved successfully

datalist
object[]
pagination
object