Skip to main content
GET
List Audience contacts

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.

Query Parameters

Search contact name, phone or email.

display_status
enum<string>[]
Available options:
created,
processing,
rescheduled,
max_retries,
completed,
dnc
campaign_id
string

Campaign UUID or none for contacts without a campaign.

dnc
boolean

When true, only contacts on the Do-Not-Call list are returned. When false, contacts on that list are excluded.

channel
enum<string>[]

Contacts with activity or a profile on any selected channel. Repeat the query parameter for multiple channels.

Available options:
call,
sms,
email,
whatsapp,
telegram,
messenger,
slack,
teams,
discord,
gchat,
x
source
string[]

Contact source tag. Repeat for multiple values; values are ORed.

tag
string[]

Contact tag. Repeat for multiple values; values are ORed.

created_from
string<date-time>

Inclusive lower bound for the contact creation timestamp.

created_to
string<date-time>

Inclusive upper bound for the contact creation timestamp.

attempts_min
integer

Minimum outbound call attempts.

Required range: x >= 0
attempts_max
integer

Maximum outbound call attempts.

Required range: x >= 0
amd_result
enum<string>[]

Last AMD result. Repeat for multiple values; none matches contacts without a result.

Available options:
human,
uncertain,
machine-vm,
machine-ivr,
machine-unavailable,
none
qa_window
default:90
Available options:
7,
30,
90
qa_average_min
number
Required range: 0 <= x <= 100
qa_average_max
number
Required range: 0 <= x <= 100
qa_min_scored_calls
integer
Required range: x >= 1
limit
integer
default:50

Page size (1–200).

Required range: 1 <= x <= 200
offset
integer
default:0

Number of items to skip.

Required range: x >= 0

Response

A page of Audience contacts with Call QA metrics when entitled.

data
object[]
required
meta
object