Skip to content

List Whatsapp Conversations

POST
/inbox/whatsapp/conversations

WhatsApp conversations across the organisation’s WhatsApp numbers, newest activity first. A read (POST for the filters).

Each row names the CRM contact it is linked to. The contact’s id, name and email appear only for contacts the key may see; for any other the chat row is kept with those fields null (or, when search is used, which also matches them, the row is left out). configured: false means the organisation has no WhatsApp numbers.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

List filters. Newest activity first; offset/limit window the list.

object
account_ids
Any of:
Array<string>
limit
integer
default: 25 >= 1 <= 100
offset
integer
search
Any of:
string
<= 200 characters
unread_only
boolean

Responses

200

Successful Response

object
data
required

An open envelope for a comment, an assignment or a workspace.

Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string