Skip to main content
GET
List Contacts

Authorizations

Authorization
string
header
required

Company API Key

Headers

X-User-Timezone
string

User's timezone for timestamp formatting (defaults to UTC)

Query Parameters

page
integer
default:1

Page number for pagination. Page size is 20 items.

Search term to filter contacts by name, email, or phone (case-insensitive)

tags
string[]

Filter contacts by tags

sort_by
enum<string>
default:last_activity

Field to sort by

Available options:
last_activity,
created_at,
score,
duration,
cost
sort_direction
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
filters
string

JSON-encoded advanced filter object (same shape as the bulk delete filters).

pn
enum<string>
default:false

When true, only return contacts that have a phone number set.

Available options:
true,
false
limit
integer
default:20

Page size (1-500). Defaults to 20.

Required range: 1 <= x <= 500

Response

List of contacts retrieved successfully

results
object[]
total
integer

Total count of contacts