Fetch chat list (inbox)

Retrieve the chat list (inbox) for the authenticated org/user, with optional filtering and cursor-based pagination.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
1 to 100

Number of chats to return. Min 1, max 100. Defaults to 10.

string
enum

Filter chats by status.

Allowed:
string

Comma-separated tag names to filter chats.

string

Phone number of the assigned agent (with or without leading +). Use the literal string 'null' to fetch unassigned chats.

string

Comma-separated WhatsApp WABA phone numbers to filter chats. Only applies to WhatsApp chats. Use instagramHandles to filter Instagram chats.

string

Comma-separated Instagram account handles to filter chats. Accepts handles with or without leading @. Only applies to Instagram chats. Use wabaNumbers to filter WhatsApp chats.

string

Pagination cursor. Pass the value of paginationOptions.nextChatId from the previous response.

number

Pagination cursor. Pass the value of paginationOptions.nextChatTimestamp from the previous response (epoch milliseconds).

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json