Skip to main content
GET
Export audience contacts
Use this endpoint to export an audience’s contacts (and call history, if any) as an Excel file (.xlsx).

Endpoint

GET /audience/contacts/export Authentication: Required (workspace auth)

Query Parameters

Response

Returns an Excel file (.xlsx) with up to two sheets:

Notes

  • The response is a binary Excel file stream, not JSON.
  • Set your HTTP client to handle binary/file responses.
  • Only active (non-deleted) contacts are included in the Audience Contacts sheet.
  • If phone number masking is enabled for the workspace, mobile numbers are masked in both sheets.
  • Recording URL links are signed (time-limited) at export time.

Error Cases

Example cURL

Headers

token
string
required

API token for authentication

Query Parameters

audience_id
integer
required

Audience identifier

Response

Excel file download

The response is of type file.