Skip to navigation
API ReferenceConversations

Get Conversation

Thread metadata plus one page of its message history. Paginate items with limit and cursor.

Authentication

x-api-keystring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

conversation_idstringRequired

Headers

X-Channel3-LanguagestringOptional
X-Channel3-CountrystringOptional
X-Channel3-CurrencystringOptional
X-Channel3-Length-UnitstringOptional
X-Channel3-Weight-UnitstringOptional

Query parameters

limitintegerOptional1-200Defaults to 50
cursorstring or nullOptional

Response

Successful Response
idstring
created_atinteger
itemslist of objects
user_idstring or nullOptional
contextobject or nullOptional

Partner-supplied context pinned to the top of a conversation thread.

next_cursorstring or nullOptional

Pass as cursor to fetch the next page. Null when no more items.

has_morebooleanOptionalDefaults to false

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error