GET
/
contacts

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

offset
integer
default: 0

Number of records to skip for pagination.

limit
integer
default: 100

Maximum number of records to return.

search
string

Search term for email, phone number, first name, or last name.

tags
string

Comma-separated list of tags to filter by.

crmScenario
string

Filter by CRM Scenario ID.

crmStep
string

Filter by CRM Step ID.

conversationStatus
enum<string>

Filter by conversation status.

Available options:
RESOLVED,
UNRESOLVED,
HUMAN_REQUESTED
agent
string

Filter by Agent ID.

priority
enum<string>

Filter by conversation priority.

Available options:
LOW,
MEDIUM,
HIGH
startDate
string

Filter contacts created on or after this date.

endDate
string

Filter contacts created on or before this date.

hasEmail
boolean

Filter contacts that have an email address.

hasPhone
boolean

Filter contacts that have a phone number.

channel
enum<string>

Filter by conversation channel.

Available options:
website,
dashboard,
whatsapp,
zapi,
telegram,
instagramDm

Response

200 - application/json
contacts
object[]
count
integer

Was this page helpful?

Delete Custom VariableCreate or Update Contact