Skip to main content
GET
Get list of chats

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

X-Device-Id
string

Device identifier for multi-device support. Required when multiple devices are registered. If only one device is registered, it will be used as the default. Can also be provided as device_id query parameter.

Example:

"my-device-id"

Query Parameters

limit
integer
default:25

Maximum number of chats to return

Required range: x <= 100
offset
integer
default:0

Number of chats to skip (for pagination)

Search chats by name

has_media
boolean
default:false

Filter chats that contain media messages

archived
boolean

Filter by archived status. true = archived only, false = non-archived only. Omit to return all chats.

Response

OK

code
string
Example:

"SUCCESS"

message
string
Example:

"Success get chat list"

results
object