Skip to content

Get a conversation including some messages

GET
/api/conversations/{conversationId}

Authorizations

api_key

Requests manipulating data need to supply a CSRF token

TypeAPI Key (header: X-CSRF-Token)

Parameters

Path Parameters

conversationId*
Typestring
Required
Pattern"[1-9][0-9]*"

Query Parameters

limit
Typeinteger

Responses

Success.

application/json
JSON
{
"conversation": {
"id": 0,
"title": "string",
"storeId": 0,
"unreadMessages": 0,
"lastMessage": {
"id": 0,
"body": "string",
"sentAt": "string",
"authorId": 0
},
"messages": [
{
"id": 0,
"body": "string",
"sentAt": "string",
"authorId": 0
}
]
},
"profiles": [
{
"id": 342528,
"name": "Franzi",
"avatar": "/api/uploads/99d1fb45-9748-3510-ac02-87b46c40048c",
"isSleeping": true
}
]
}

Playground

Authorization
Variables
Key
Value

Samples

cURL
JavaScript
PHP
Python