Chats
Get chat by Topic ID
AuthorizationBearer <token>
OAuth 2.1 authorization code flow with PKCE (required of every client, public or confidential). Scopes are a ceiling on the credential, not a grant of access: a token also cannot exceed what the user who approved it may already do. A write scope does not imply its matching read — ask for both.
In: header
Scope: chat:read
Path Parameters
topicId*string
Unique identifier for the topic
Match
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$Format
uuidQuery Parameters
topicType?string
Type of the chat topic
Value in
- "project"
- "asset"
- "public"
- "task"
visibility?string
Visibility of the chat
Value in
- "creator"
- "reviewer"
messages?integer
Number of recent messages to retrieve. Note - the current handler does not forward this value, so the default of 10 is always applied.
Range
value <= 100Default
10replies?integer
Number of recent replies to retrieve
Range
value <= 100Default
10sort?
Sorting options for the chat
Default
{ "id": -1}Response Body
application/json
curl -X GET "https://example.com/chats/topic/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "chatType": "topic", "topicId": "97b608a9-302e-4387-a5f4-fd35969cdc21", "topicType": "asset", "replyType": "quote", "subject": "string", "visibility": "creator", "publicId": "f72dfe8e-6cfd-43c2-b1cb-95adbf313789", "participants": [ "e3139958-26f5-4fd4-a9c9-fe1c29c5cbac" ], "following": [ "6bc36f94-42f8-4778-8086-0f778a9e5f30" ], "annotations": [ {} ], "totalMessages": 0, "lastMessageAt": "2019-08-24T14:15:22Z", "recentMessages": [ "6738c803-41a8-4296-a5bd-8d9974ec6fa0" ], "activeConvoId": "6ac5e0e4-f5db-4276-ac1c-9dd077ad79d2", "activeConvo": "d97b3779-3421-4076-bf6e-15252c014d1d", "status": "active", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}