Skip to main content
GET
List contacts

Authorizations

Authorization
string
header
required

API key authentication. Use your API key as the bearer token.

Query Parameters

limit
string
Example:

"100"

offset
string
Example:

"0"

subscribed
string
Example:

"true"

Search contacts by email, first name, or last name (case-insensitive)

Example:

"john"

tags
string

Comma-separated tags to filter by (AND logic)

Example:

"newsletter,vip"

segment
string<uuid>

Filter contacts by segment ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

List of contacts

contacts
object[]
required
total
integer
required
limit
integer
required
offset
integer
required