Get messages for a chat
Returns active messages for a chat with recent replies and populated attachments/mentions. API tokens require the `chat:read` scope (`tokenScopeMissing` / 403 otherwise). `createdBefore` / `createdAfter` are only accepted with index pagination.
Returns active messages for a chat with recent replies and populated attachments/mentions. API tokens require the chat:read scope (tokenScopeMissing / 403 otherwise). createdBefore / createdAfter are only accepted with index pagination.
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
^[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}$uuidQuery Parameters
Pagination type to use
"index"Value in
- "cursor"
- "index"
Page number for index pagination
1Cursor for pagination
If true, paginates in reverse order
falseIf true, includes count information
falseInclude cursor record in results (only for cursor pagination)
falseID of the record to start pagination from (only for cursor pagination)
Include the startAt record in the results (only for cursor pagination)
trueExclude replies from the results
falseSorting criteria for messages
Default
{ "id": -1}Number of messages per page
value <= 10020Number of replies to include per message
value <= 10010Deprecated alias of replyLimit. When set to a value other than 10 it takes precedence over replyLimit.
value <= 10010Filter to highlighted (true) or non-highlighted (false) messages
Case-insensitive substring search on message content
length <= 200Only return user or system messages
Value in
- "user"
- "system"
Only return messages with (true) or without (false) attachments
Only return messages with (true) or without (false) annotations
Only return convo system messages (true) or exclude them (false)
Sorting criteria for replies
Default
{ "id": -1}Timestamp or ID indicating the upper bound of result creation time. A numeric timestamp is Unix time in milliseconds; a value that looks like seconds is rejected with a 400 validationError. You may preface an ID with a '+' to make the results inclusive of that result Meaning <= instead of just <.
Timestamp or ID indicating the lower bound of result creation time. A numeric timestamp is Unix time in milliseconds; a value that looks like seconds is rejected with a 400 validationError. You may preface an ID with a '+' to make the results inclusive of that result Meaning <= instead of just <.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/chats/497f6eca-6276-4993-bfeb-53cbbbba6f08/messages"{ "page": 0, "limit": 0, "totalPages": 0, "totalResults": 0, "queryAt": 0, "results": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "user", "dataType": "notification", "dataId": "5647597e-5960-4cd9-8287-791d36aa4685", "data": "808ac6e4-93ed-4040-85a5-6c71a2444e90", "chatId": "f255124e-3419-4f6e-b7ee-17a6577db94d", "chatType": "topic", "authorId": "ee6f7132-bd0a-4fcd-83b3-a8022377067b", "author": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "firstName": "string", "lastName": "string", "displayName": "string", "avatar": "01d8bd6c-6014-46aa-b5b1-14d337c9c779", "color": "string", "awards": [ "staff" ], "accountType": "standard" }, "guestId": "db7efe8f-f9c5-48b1-ba1e-30c39617b97d", "guestName": "string", "guestColor": "string", "replyToId": null, "content": "string", "mentions": [ "777c52f7-3433-49cb-b0a3-cd6473c2c951" ], "assetMentions": [ "33c9f99d-d0e6-413a-8a20-2b070ddbb3e6" ], "folderMentions": [ "16b8140a-38c5-4330-83d5-bd6117a3e481" ], "submissionMentions": [ "dfb873dd-628b-446d-a7b3-aef774c3c50a" ], "publicMentions": [ "string" ], "taskMentions": [ "bb41b8dc-c355-4766-acc1-55693c83896e" ], "taskCards": [ "e3196039-692a-4ea1-be8d-6850035a72f9" ], "suggestedTasks": [ { "subject": "string", "description": "string", "assignedToId": "7a15e53b-1403-4928-9451-d7062c3a8737", "boardId": "a654038e-9287-48a2-acfd-90b8cfa8b1f4", "columnId": "b0676e1a-d8a0-4c5f-99e7-a0ee8909f6dd" } ], "quotes": [ "ea3b6941-45f7-4e0a-8d2b-6582d4d35a68" ], "attachments": [ "9904dd49-22c6-4edb-be09-aa27b9abd8f3" ], "revisions": [ {} ], "meta": {}, "status": "active", "totalReplies": 0, "recentReplies": [ "45984f84-2e0e-475b-b8a5-e4cfa03139f5" ], "annotations": [ { "color": "#9b9b9b", "frame": 0, "timestamp": 0, "startTimestamp": 0, "endTimestamp": 0, "left": 0, "top": 0, "width": 0.1, "height": 0.1, "scaleX": 1, "scaleY": 1, "angle": 0, "skewX": 0, "skewY": 0, "flipX": false, "flipY": false, "originX": "left", "originY": "top", "opacity": 1, "visible": true, "shadow": { "color": "rgba(0,0,0,0.3)", "blur": 5, "offsetX": 0.2, "offsetY": 0.2 }, "strokeLineCap": "butt", "strokeLineJoin": "miter", "strokeMiterLimit": 4, "strokeDashArray": [ 0.1 ], "fillRule": "nonzero", "nestedAnnotations": [ { "type": "dot", "coordinates": { "x": 0, "y": 0 }, "radius": 10 } ], "type": "dot", "coordinates": { "x": 0, "y": 0 }, "radius": 10 } ], "linkPreviews": [ { "url": "http://example.com", "title": "string", "description": "string", "image": "http://example.com", "siteName": "string", "favicon": "http://example.com", "signature": "string" } ], "reactions": [ { "user": "76f62a58-5404-486d-9afc-07bded328704", "emoji": "👍" } ], "highlighted": false, "highlightedById": "2ed80d19-af19-4b14-bdad-240edd29da18", "highlightedAt": 0, "isConvoMessage": false, "scopeId": "65fafe40-a220-4dd7-8724-4598b81c0643", "scopeType": "project", "scopeVisibility": [ "creator" ], "inheritanceId": "09c886ac-e6e5-4263-a494-a6e14f7e4f46", "aiRole": "assistant", "aiModel": "string", "aiTokensIn": 0, "aiTokensOut": 0, "aiToolCalls": [ {} ], "aiToolResults": [ {} ], "aiUsageEventId": "f5c2aaa2-8335-4359-b76a-d9a02c9cdabb", "createdAt": 1678886400000, "updatedAt": 1678886400000 } ]}