Authorizations

Authorization
string
header
required

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

Headers

x-phone
string

Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header

Query Parameters

offset
number
  • The offset value for paginating the results
  • Default 0
limit
number
  • The maximum number of chats to retrieve
  • Default 2000
chat_type
string
  • Filter chat by type of user, group or business
label
string
  • Filter all chats that contain a specific label provide
  • You can provide the name of the label or label_id

Response

200 - application/json

Note: members associated with a chat are not returned. You can fetch a specific chat by calling the Get Chat By ID endpoint

chats
any[]

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

count
number

The total count of chats.

from
number

The starting index of the returned chats.

to
number

The ending index of the returned chats.