v1
latestOpenAPI 3.0.32026-07-26870417.2 KBchats
List All Chats
This endpoint retrieves a paginated list of chats
get/chats
Query parameters
offsetnumber
- The offset value for paginating the results
- Default 0
limitnumber
- The maximum number of chats to retrieve
- Default 2000
sort_by'created_at' | 'latest_message_timestamp'
- Value to sort the incoming chats
- Possible values: created_at, latest_message_timestamp
- Default created_at
Example:created_at
sort_order'asc' | 'desc'
- Order to sort the results
- Possible values: asc, desc
- Default desc
Example:desc
chat_idstring
- Filter to a specific chat by its chat_id (the chat's unique WhatsApp identifier, e.g. a group id ending in @g.us or a contact id ending in @c.us). Returns that single chat, the same way the Get Chat By ID endpoint does.
Example:120363392071406466@g.us
chat_typestring
- Filter chat by type of user, group or business
Example:group
labelstring
- Filter all chats that contain a specific label provide
- You can provide the name of the label or label_id
Example:label-kbvlbnvesomvgqpt
start_timestring
- The start_time to filter the results
Example:2025-04-25 or 2025-04-25T00:00:00Z
end_timestring
- The end_time to filter the results
Example:2025-04-31 or 2025-04-31T23:59:59Z
Headers
x-phonestring
Example:{{orgPhone}}
Optional. The phone to scope this request to — in country code + number format with no spaces or special characters (e.g. 919876543210), or the phone_id (phone-xxxxxxxxxxxx). When set, only chats for that phone are returned. When omitted, chats are returned — across all phones your token can access (the phones in your token's scope, or every phone in your organization if the token is unscoped). Passing a phone that is outside your token's scope returns a 401.
Response
200 OK
Example response
{
"from": 1,
"to": 10,
"count": 10
}