Chats
List chats
List the chats (conversations) the connected WhatsApp engine sees, most-recent first.
Offset-paginated via limit + skip, with an optional case-insensitive substring search on the chat name via searchToken and a filter to restrict to one chat kind. Requires chats:read.
Request
curl -X GET "https://api.blueticks.co/v1/chats"{
"success": true,
"data": [
{
"id": "string",
"name": "string",
"is_group": true,
"is_newsletter": true,
"last_message_at": "2019-08-24T14:15:22Z",
"unread_count": 0,
"marked_unread": true
}
],
"limit": 0,
"skip": 0,
"total": 0
}{
"success": false,
"error": {
"code": "string",
"message": "string",
"request_id": "string",
"details": [
{
"path": "string",
"code": "string",
"message": "string"
}
]
}
}Query Parameters
searchToken?string
Search token; when set, only items whose name matches are returned.
Length
length <= 200filter?string
Restrict to one chat kind.
Value in
"groups" | "contacts" | "newsletters"include_last_message?boolean
Include the last message snippet on each chat row.
include_extended_info?boolean
Include extended chat metadata (engine-side opt-in).
include_without_name?boolean
Include chats with no resolved name (default: skipped).
skip?integer
Number of items to skip before the page (default 0).
Default
0Range
0 <= valuelimit?integer
Page size (1-200, default 50).
Default
50Range
1 <= value <= 200Response
Response Body
application/json
application/json