v10

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-02-242335121.2 KB

Chats

List chats

List all chats sorted by last activity (most recent first). Combines all accounts into a single paginated list.

get/v1/chats

Query parameters

cursorstring

Opaque pagination cursor; do not inspect. Use together with 'direction'.

Example:1725489123456|c29tZUltc2dQYWdl

Opaque pagination cursor; do not inspect. Use together with 'direction'.

direction'after' | 'before'

Pagination direction used with 'cursor': 'before' fetches older results, 'after' fetches newer results. Defaults to 'before' when only 'cursor' is provided.

Example:before

Pagination direction used with 'cursor': 'before' fetches older results, 'after' fetches newer results. Defaults to 'before' when only 'cursor' is provided.

accountIDsstring[]

Limit to specific account IDs. If omitted, fetches from all accounts.

[
  "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc",
  "local-instagram_ba_eRfQMmnSNy_p7Ih7HL7RduRpKFU"
]

Response

Request executed successfully

hasMoreboolean required

True if additional results can be fetched using the provided cursors.

oldestCursorstring nullable required

Cursor for fetching older results (use with direction='before'). Opaque string; do not inspect.

newestCursorstring nullable required

Cursor for fetching newer results (use with direction='after'). Opaque string; do not inspect.

Example response

{
  "items": [
    {
      "id": "!instagram_mattwondra:local-instagram.localhost",
      "localChatID": "1229391",
      "accountID": "local-instagram_ba_eRfQMmnSNy_p7Ih7HL7RduRpKFU",
      "title": "Matt Wondra",
      "type": "single",
      "participants": {
        "items": [
          {
            "id": "@mattwondra:local-instagram.localhost",
            "username": "mattwondra",
            "fullName": "Matt Wondra",
            "cannotMessage": false,
            "isSelf": false
          },
          {
            "id": "@batuhan:local-instagram.localhost",
            "username": "batuhan",
            "fullName": "Batuhan İçöz",
            "cannotMessage": false,
            "isSelf": true
          }
        ],
        "hasMore": false,
        "total": 2
      },
      "lastActivity": "2025-08-31T19:41:41.000Z",
      "unreadCount": 0,
      "lastReadMessageSortKey": "449706228480",
      "isArchived": false,
      "isMuted": false,
      "isPinned": false
    }
  ],
  "oldestCursor": "1725489123456",
  "newestCursor": "1725489123456"
}