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": [
    {
      "chatId": "string",
      "name": "string",
      "chatType": "contact",
      "pinned": true,
      "archived": true,
      "lastMessageAt": "2019-08-24T14:15:22Z",
      "unreadCount": 0,
      "markedUnread": true,
      "lastMessageText": "string",
      "lastMessageFromMe": true
    }
  ],
  "limit": 0,
  "skip": 0,
  "total": 0,
  "nextCursor": "string"
}

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "string",
    "requestId": "string",
    "details": [
      {
        "path": "string",
        "code": "string",
        "message": "string"
      }
    ],
    "upgrade": {
      "url": "string",
      "text": "string",
      "reset_time": "string",
      "seconds_remaining": 0,
      "plan": {}
    }
  }
}

Query Parameters

searchToken?string

Search token; when set, only items whose name matches are returned.

Lengthlength <= 200

engine?string

Force the read to a specific engine TYPE: "gateway" (server-side pod, e.g. Baileys) or "regular" (browser extension). Overrides the default dual-engine read preference. 409 ENGINE_NOT_ONLINE if none of that type is online.

Value in"gateway" | "regular"

engineId?string

Exact engine clientId to target (from the engine status id); wins over engine. 409 ENGINE_NOT_ONLINE if not online.

Length1 <= length <= 200

filter?string

Restrict to one chat kind.

Value in"groups" | "contacts" | "newsletters"

kinds?array<>

Keep only these chat kinds (INCLUDE semantics). Comma-separated or repeated.

Items1 <= items

since?string

Keep only chats whose last message is at/after this ISO 8601 instant (offset allowed; approximate — see sinceApplied).

Formatdate-time

includeLastMessage?boolean

Include the last message snippet on each chat row.

includeWithoutName?boolean

Include chats with no resolved name (default: skipped).

includeArchive?boolean

Include archived chats (default false → archived excluded).

skip?integer

Number of items to skip before the page (default 0).

Default0

Range0 <= value

limit?integer

Page size (1-200, default 50).

Default50

Range1 <= value <= 200

List chats

Request

Query Parameters

Response

Response Body

`application/json`

`application/json`

List chats

Request

Query Parameters

Response

Response Body

200application/json

Error codesapplication/json

`application/json`

`application/json`