API referenceChats
List chats
Returns chats from stored data for one session.
Use limit and cursor to page results. Requires read capability.
Errors: forbidden if missing read, not_found if the session is not accessible.
AuthorizationBearer <token>
Send Authorization: Bearer <token>. The token can be a login JWT from the frontend or an api-key for a script. JWT access comes from the person's organization role. Api-key access comes from the permissions saved on the key.
In: header
Path Parameters
session*string
WhatsApp session id. Must belong to the caller organization.
Example
"01HF..."Query Parameters
limit?integer
Page size. Missing or 0 uses 50, clamped to 1-200.
Format
int64Example
50cursor?string
Opaque pagination cursor from the previous response's nextCursor.
Example
""Response Body
application/json
application/json
curl -X GET "https://example.com/api/v1/sessions/01HF.../chats"{ "data": [ { "aliases": [ "205227043110953@lid" ], "archived": false, "id": 3344, "jid": "6281234567890@s.whatsapp.net", "lastMessageAt": 1719662400000, "mutedUntil": 1751198400000, "name": "Alice", "pinned": false, "sessionId": "01J9ZX8K2QHV0M3T6R7P4N5W8C", "type": "dm", "unreadCount": 3 } ], "nextCursor": "string"}{ "error": { "code": "not_found", "details": { "property1": null, "property2": null }, "message": "session not found" }}