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). For member-scoped tokens, the result is intersected with the member-visible chat set; an invisible account id contributes no chats except chats where the member is responsible.

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

ads_source_id
string

filters chats that received a referral from this Meta ad (source_type ad with this source_id), whether it opened the chat or came later. Post referrals never match. With ads_source_after / ads_source_before, the id and the time are checked on the same referral.

Minimum string length: 1
ads_source_after
string

filters chats with an ad referral at or after this time. ISO date or datetime; a value without a UTC offset is read in the workspace timezone, and a date alone means the start of that day.

ads_source_before
string

filters chats with an ad referral at or before this time. ISO date or datetime; a value without a UTC offset is read in the workspace timezone, and a date alone covers that whole day.

page
integer

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

page_size
integer

Number of items per page. Defaults to 50. Minimum 1. Maximum 100.

Required range: 1 <= x <= 100
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