Skip to main content
GET
List contacts

Authorizations

Authorization
string
header
required

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

Query Parameters

page
integer | null
Required range: 1 <= x <= 9007199254740991
perPage
integer | null
Required range: 1 <= x <= 9007199254740991
sort
object[] | null
keyword
string
contactFilter
object
channels
enum<string>[]
Available options:
omnichannel,
webchat,
messenger,
whatsapp,
zalo,
smtp,
telegram,
instagram,
tiktok
inboxIds
string[]
Pattern: \d+

Response

200 - application/json

OK

data
object[]
required
pageCount
number
required