Skip to main content
GET
List all Chat Messages
Retrieve the messages of a chat as a paginated list, ordered as a conversation history.

Authentication

This request requires your API key in the x-api-key header.

Request

chatId
string
required
ID of the chat whose messages you want to list.

Response

items
object[]
required
The messages on the current page.
totalItems
number
required
Total number of messages across all pages.
size
number
required
Number of items per page.
totalPages
number
required
Total number of pages.
currentPage
number
required
The current page number.
hasPrevPage
boolean
required
Whether a previous page exists.
hasNextPage
boolean
required
Whether a next page exists.
prevPage
number
The previous page number, or null if there is none.
nextPage
number
The next page number, or null if there is none.

Examples

Success response

Error response

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

chatId
string
required

Response

200 - application/json
items
object[]
required
totalItems
number
required
size
number
required
totalPages
number
required
currentPage
number
required
hasPrevPage
boolean
required
hasNextPage
boolean
required
prevPage
number | null
nextPage
number | null