Retrieve a conversation

get/v1/conversations/{id}

Returns one conversation by ID.

Authorization

Authorization: Bearer ak_...requiredscope: read

An AveeCare API key created in Settings → API Keys. A read or read + write key can call this endpoint. About authentication

stringrequired

ID of the conversation.

200

The conversation.

object

stringread-only

String representing the object's type. Always conversation.

stringread-only

Unique identifier of the conversation.

participantIds

array of strings | nullread-only

User IDs of everyone in the conversation.

isGroup

boolean | nullread-only

Whether this is a group chat.

title

string | nullread-onlymax length 2000

Group chat name; null for one-to-one chats.

lastMessageTime

string · date-time | nullread-only

When the most recent message was sent.

lastMessageContent

string | nullread-onlymax length 20000

Preview of the most recent message.

lastMessageSenderId

string | nullread-onlymax length 64

User ID of whoever sent the most recent message.

createdAt

string · date-time | nullread-only

When the conversation was created.

updatedAt

string · date-time | nullread-only

When the conversation was last changed.

Request-IdstringUnique ID of this request. Quote it when contacting support.

RateLimit-LimitintegerRequests allowed in the current window.

RateLimit-RemainingintegerRequests left in the current window.

RateLimit-ResetintegerSeconds until the window resets.

Status	Code	Meaning
401	n/a	The API key is missing, malformed, expired or revoked (`unauthorized`).
403	n/a	The key is read-only (`insufficient_scope`), or its user's role cannot do this (`forbidden`).
404	n/a	No such object, or it is not visible to this key (`not_found`).
429	n/a	Too many requests (`rate_limited`). Wait for `Retry-After` seconds.
500	n/a	Something went wrong on our side (`internal_error`). Retry, and quote the request ID if it persists.

Every error uses the same body. See Errors for the full list of codes.