List Inbox Chats

get

https://api.unipile.com/v2/{account_id}/inboxes/{inbox_id}/chats

Returns a list of account's chats from a specific inbox.
The chats are returned sorted by their last message date, with the most recent appearing first.
Filters are applied with an AND logic if supported by the provider.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

inbox_id

string

required

length ≥ 1

ID of the Inbox to retrieve Chats from. Use List all Inboxes to get the ID of an inbox.

account_id

string

required

^acc_(.*)$

ID of the Account (acc_xxx) to call the method on behalf of.

Query Params

offset

number

An offset used for pagination, if supported by the provider, else use cursor.

cursor

string

A cursor used for pagination. If supported by the provider, use next_cursor given by the previous page of the list, else use offset.

limit

number

≥ 1

Defaults to 20

The limit of items to be returned. The maximum allowed value depends on the provider.

type

string

enum

Return only chats of the given type (if supported by the provider).
- 1to1 is a 1to1 chat.
- group is a group chat.
- channel is a channel chat.

Allowed:

before

string

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

after

string

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

is_archived

boolean

Return only chats of the given archived status (if supported by the provider).

is_unread

boolean

Return only chats of the given unread status (if supported by the provider).

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Default Response