Skip to main content
GET
Get Contacts

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

The ID of the org

Query Parameters

Search contacts by name

Maximum string length: 256
unsubscribed
boolean

Whether the contact is unsubscribed

user_id
string

Search contacts by user ID match

name
string

Search contacts by name match

Maximum string length: 256
username
string

Search contacts by username match

Maximum string length: 256
email
string<email>

Search contacts by email match

Maximum string length: 256
segment_id
string

Search contacts by segment ID match

Maximum string length: 128
exclude_admins
boolean

Exclude admin contacts

status
enum<string>

Filter contacts by subscription status

Available options:
ALL,
SUBSCRIBED,
UNSUBSCRIBED,
BLOCKED,
AI_REPLIES_OFF
page
number

Page number

take
number

Number of items to take

next
string

Next page token (Only used on special endpoints)

Response

200 - application/json
id
string
required
name
string | null
required
blocked
boolean
required
unsubscribed
boolean
required
ai_replies
boolean
required
is_admin
boolean
required
channels
object[]
required
segments
object[]
required
properties
object
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
blocked_at
string<date-time>
unsubscribed_at
string<date-time>
unsubscribe_reason
string
unsubscribe_feedback
string
ai_replies_at
string<date-time>