GET
/v1/definitions/{key}/threads/{threadId}Read a discussion thread
One internal thread with its roster, its resolved state and the caller's unread count. Addressed by the THREAD, with no row id in the path, because a thread id already names one record and repeating it would let the two disagree. The messages are a separate read.
Access class: def:read.
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.
keypath · stringrequired
threadIdpath · stringrequired
bodyquery · nulloptional
paramsquery · objectoptional
:keystringoptional
:threadIdstringoptional
queryquery · objectoptional
Responses
200application/json
the action's answer
{
"data": {
"createdAt": "string",
"createdBy": 1.5,
"definitionKey": "string",
"id": "",
"lastMessageAt": "string",
"messageCount": 1.5,
"participants": [
{
"addedAt": "string",
"email": "string",
"isMuted": true,
"lastReadAt": "string",
"name": "string",
"role": "string",
"userId": 1.5
}
],
"recordName": "string",
"resolvedAt": "string",
"resolvedBy": 1.5,
"rowId": "",
"status": "string",
"subject": "string",
"unread": 1.5,
"updatedAt": "string"
}
}datarequired
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