Skip to main content
GET
Get a message

Authorizations

Authorization
string
header
required

An API key (onx_sk_…) created in OnlyX under Settings → API & MCP, or an OAuth access token (onx_at_…) issued to a connected app. Send it as Authorization: Bearer <credential>. API keys may also be sent as X-API-Key: <key>.

Path Parameters

conversationId
string
required

The conversation id (cnv_…).

Maximum string length: 40
messageId
string
required

The message id (msg_…).

Maximum string length: 40

Response

The message, with its delivery status if it is outgoing.

conversationId
string
required

The conversation it belongs to.

createdAt
string | null
required

When the message was sent (or, for a queued send, accepted).

delivery
Delivery · object | null
required

Delivery of an outgoing message. null for incoming messages.

direction
enum<string>
required

in from the fan, out to the fan.

Available options:
in,
out
id
string
required

The message id (msg_…).

media
MessageMedia · object[]
required

Media attached to the message.

paid
Paid · object | null
required

Set on a paid message, otherwise null.

sender
enum<string>
required

Who wrote it: the fan, the AI chatter, or your team (including anything sent through the API).

Available options:
fan,
ai,
team
text
string
required

The message text. May be empty when the message is media only.

tipCents
integer | null
required

A tip that came with this message, in cents, or null.