UNunipile
Messaging

List all chats

Changed on

Returns a list of chats. Some optional parameters are available to filter the results.

get/api/v1/chats

Request

Query parameters

unreadboolean

Whether you want to get either unread chats only, or read chats only.

cursorstring

A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.

beforestring

A filter to target items created before the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).

Example:2025-12-31T23:59:59.999Z
afterstring

A filter to target items created after the datetime (exclusive). Must be an ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).

Example:2025-12-31T23:59:59.999Z
limitinteger

A limit for the number of items returned in the response. The value can be set between 1 and 250.

Example:100
account_type'WHATSAPP' | 'LINKEDIN' | 'SLACK' | 'TWITTER' | 'MESSENGER' | 'INSTAGRAM' | 'TELEGRAM'

A filter to target items related to a certain provider.

account_idstring

An Unipile account id or a list of Unipile account ids separated by commas.

A filter to target items related to a certain account. Can be a comma-separated list of ids.

Response

OK. Request succeeded.

object'ChatList' required

Changes

  • e74f29ca2aaaRevision changes
    • warning

      added the new errors/password_reset_required enum value to the response property for the response status