Skip to main content
GET
List audience contacts
List contacts with pagination and filtering. Requires the audience:read scope.

Authorizations

Authorization
string
header
required

API key for authentication

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
per_page
integer
default:20

Items per page (max 100)

Required range: 1 <= x <= 100

Search by email or contact name

Maximum string length: 255
status
enum<string>

Filter by contact status

Available options:
subscribed,
unsubscribed,
bounced,
complained,
unverified
list_id
string<uuid>

Filter to contacts in a specific list (must belong to the team)

segment_id
string<uuid>

Filter to contacts matching a specific segment (must belong to the team)

Response

Contacts retrieved successfully.

message
string
required
Example:

"Contacts retrieved successfully."

data
object
required