Skip to main content
GET
cURL

Authorizations

X-API-Key
string
header
required

API key authentication. Pass your API key in the X-API-Key header.

Query Parameters

agent
string<uuid>
contact
string
Minimum string length: 1
hasUnread
boolean
lastMessageAfter
string<date-time>
lastMessageBefore
string<date-time>
limit
integer

Pagination limit (default 20, max 100)

offset
integer

Pagination offset (default 0)

ordering
enum<string>
default:-last_message_time
  • -last_message_time - -last_message_time
  • last_message_time - last_message_time
  • -created_at - -created_at
  • created_at - created_at
  • -updated_at - -updated_at
  • updated_at - updated_at
Available options:
-last_message_time,
last_message_time,
-created_at,
created_at,
-updated_at,
updated_at
Minimum string length: 1
status
enum<string>
  • active - active
  • closed - closed
Available options:
active,
closed
Minimum string length: 1
whatsappNumber
string

WhatsApp business number

Minimum string length: 1

Response

200 - application/json
count
integer
required
Example:

123

results
object[]
required
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"