Skip to main content
GET
List a conversation's messages
Minimum role required: Viewer

Authorizations

X-Axilio-Api-Key
string
header
required

Customer API key (axl_ prefix).

Path Parameters

conversation_id
string<uuid>
required

conversation identifier

Query Parameters

limit
integer<int64>
default:50

max items per page

Required range: 1 <= x <= 100
offset
integer<int64>
default:0

pagination offset

Required range: x >= 0
order_by
string
default:created_at desc

Sort expression 'created_at [asc|desc]': when the platform stored each message, newest first by default.

Pattern: ^created_at( (asc|desc))?$

Response

OK

One page of the organization's messages.

messages
object[] | null
required

Messages, newest first by created_at.

total
integer<int64>
required

Total messages matching the query.