Skip to main content
GET
Get a conversation

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_…), from GET /v1/conversations.

Maximum string length: 40

Response

The conversation, with the full fan, the open hand-off and whether the AI would reply.

aiCanReply
boolean
required

Whether the AI would answer this chat right now: the creator's AI is on and set up, the chat is ai, and she is connected.

creatorId
string
required

The creator whose inbox this conversation is in.

fan
Fan · object
required

The fan, in full.

Example:
handoff
Handoff · object | null
required

The open hand-off on this conversation, or null.

Example:
id
string
required

The conversation id (cnv_…).

lastMessage
LastMessage · object | null
required

The latest message, or null for an empty conversation.

lastMessageAt
string | null
required

When the latest message was sent.

status
enum<string>
required

Who answers this chat (see Conversation.status).

Available options:
ai,
team,
handoff,
ai_off
takenOverUntil
string | null
required

While status is team: when the chat returns to the AI on its own. Otherwise null.

totalSpentCents
integer
required

Everything this fan has spent on the creator, in cents.

unreadCount
integer
required

Fan messages not yet marked read in OnlyX.