Authorizations

Authorization
string
header
required

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

Query Parameters

offset
number
  • The offset value for paginating the results
  • Default 0
limit
number
  • The maximum number of contacts to retrieve
  • Default 2000

Response

200 - application/json

Note: chat_ids associated with a contact are not returned. You can fetch a specific contact by contact_id to get all chat_ids associated with it

contacts
any[]

An array of contact objects. Refer to the contact object here

count
number

The total count of contacts.

from
number

The starting index of the returned contacts

to
number

The ending index of the returned contacts