Skip to main content
POST
List archives
Required scopes: or

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
filters
object

Archive filters.

highlights
object

Highlight configuration for search query matches.

sort_order
enum<string>
default:desc

asc for oldest chats first, desc for newest chats first.

Available options:
asc,
desc
limit
integer
default:10

Maximum number of records per page.

Required range: 1 <= x <= 100
page_id
string

Pagination token.

Response

200 - application/json

Archived chats.

chats
object[]

Array of chat objects.

found_chats
integer

Total number of found chats.

next_page_id
string

Pagination token for the next page.

previous_page_id
string

Pagination token for the previous page.