Retrieve a paginated list of chat conversations with filtering and search capabilities.
Use pagination parameters to efficiently handle large numbers of chats.
Request Device identifier for multi-device support. Required when multiple devices are registered. If only one device is registered, it will be used as the default.
Maximum number of chats to return per page (max: 100)
Number of chats to skip for pagination
Search chats by name or phone number
Filter to only include chats that contain media messages
Filter by archived status:
true: Return only archived chatsfalse: Return only non-archived chatsOmit parameter: Return all chats
Response Response code (e.g., SUCCESS)
Response message describing the result Example: Success get chat list
Array of chat objects Timestamp of the last message (ISO 8601 format)
Ephemeral message expiration time in seconds (0 = disabled)
Chat last update timestamp
Whether the chat is archived
curl -X GET \ 'https://your-api-domain.com/chats?limit=25&offset=0&search=John' \ -H 'X-Device-Id: my-device' \ -u 'username:password'
{ "code" : "SUCCESS" , "message" : "Success get chat list" , "results" : { "data" : [ { "jid" : "[email protected] " , "name" : "John Doe" , "last_message_time" : "2024-01-15T10:30:00Z" , "ephemeral_expiration" : 0 , "created_at" : "2024-01-10T08:00:00Z" , "updated_at" : "2024-01-15T10:30:00Z" , "archived" : false } ], "pagination" : { "limit" : 25 , "offset" : 0 , "total" : 150 } } }
