GET
/v1/comms/conversationsList conversations
The inbox: every conversation the person may see, with its participants and latest activity. Start here for anything about messages, replies or who last wrote. Narrow to one record's conversations with definitionId (the record page's id from its definition, a uuid, not its key) and rowId (the record's id) together — one without the other is refused.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
API serverbase URL
Bearer tokensessionoptional
Stored only in this browser for the session security scheme and reused on every API page in this group.
Parameters
Values are applied to the request and the example on the right.
bodyquery · nulloptional
paramsquery · objectoptional
queryquery · objectoptional
archivedbooleanoptional
connectedstringoptional
contactstringoptional
definitionIdstringoptional
limitintegeroptional
mediumstringoptional
offsetintegeroptional
rowIdstringoptional
unreadbooleanoptional
Responses
200application/json
the action's answer
{
"conversations": [
{
"account_identifier": "string",
"contact_identifier": "string",
"contact_name": "string",
"contact_role": "string",
"created_at": "string",
"id": 1.5,
"is_archived": true,
"is_muted": true,
"is_pinned": true,
"is_starred": true,
"last_message_at": "string",
"last_message_direction": "string",
"last_message_preview": "string",
"medium": "string",
"ownerAccountId": "",
"records": [
"string"
],
"unread_count": 1.5,
"visibility": "string"
}
],
"total": 1.5
}conversationsarray<>required
totalnumberrequired
defaultapplication/json
a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}errorstringrequired