Skip to main content
GET
Get a conversation
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

Response

OK

A conversation: one of your dedicated phones and the people it texts with.

created_at
string<date-time>
required

When the conversation's first message was stored.

id
string
required

Conversation identifier. Opaque: don't derive it, read it from a conversation or a message's conversation_id.

is_group
boolean
required

True for a group conversation: more than one other person.

last_message
object
required

The conversation's latest message.

last_message_at
string<date-time>
required

When the latest message was stored. Conversations list newest activity first by this time.

participants
object[] | null
required

Everyone on the conversation but your phone. Empty when the sender's number is unknown.

phone_id
string
required

The dedicated phone this conversation is on.

phone_number
string | null
required

That phone's own number in E.164: what its SIM reports, or else the number its latest received text was sent to. Null when neither is known, or when the phone is no longer one your organization rents.