Skip to main content
GET
Get full or filtered list of all WABA chats in the Workspace.

Authorizations

Authorization
string
header
required

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

Query Parameters

waba_account_id
string

filters WABA chats belonging to one of the specified WABA accounts (comma-separated internal account ids)

responsible
string

filters chats assigned to specific users (denoted by email address, comma-separated)

closed
boolean

filter chats that are either closed (true) or open (false)

whatsapp_phone
string

filter WABA chats by contact phone number

page
integer

specify the page of results (each page contains up to 50 items), starting with 1. Check "has more page" response value to see if more pages are available.

with_msg
boolean

when true, include the full last_message object (in addition to last_message_uid / last_message_timestamp) for each chat.

Response

Success

status
enum<string>
required
Available options:
ok,
error
Example:

"ok"

data
object
required