Get mentionable folders for a chat with pagination
Returns a paginated list of folders that can be mentioned in the specified chat. The folders returned depend on the chat type: - **Topic chat about a project**: Returns folders from that project with matching visibility - **Topic chat about an asset**: Returns folders from the asset's owner project with matching visibility - **Member chat with project scope**: Returns all folders from that project (all visibilities) - **Submission chat**: Returns reviewer-visibility folders from the project - **AI chat (Nu Chat)**: Returns folders from the topic's project, filtered to the **caller's own** visibility tiers. A workspace- or social-scoped topic has no project to resolve against and returns an empty array. Unlike every other chat type above, an AI chat has no meaningful visibility of its own to inherit — its backing `Chat` row is created with a fixed `creator` placeholder, identical for every user — so tiers are derived from the caller's inherited permissions instead. Owning the topic is not on its own evidence of creator-tier access to the project. - **Member chat with workspace/social scope**: Returns empty array (no folders are mentionable) Only active folders are returned. Supports both cursor-based and index-based pagination, plus name filtering.
Returns a paginated list of folders that can be mentioned in the specified chat. The folders returned depend on the chat type:
-
Topic chat about a project: Returns folders from that project with matching visibility
-
Topic chat about an asset: Returns folders from the asset's owner project with matching visibility
-
Member chat with project scope: Returns all folders from that project (all visibilities)
-
Submission chat: Returns reviewer-visibility folders from the project
-
AI chat (Nu Chat): Returns folders from the topic's project, filtered to the caller's own visibility tiers. A workspace- or social-scoped topic has no project to resolve against and returns an empty array.
Unlike every other chat type above, an AI chat has no meaningful visibility of its own to inherit — its backing
Chatrow is created with a fixedcreatorplaceholder, identical for every user — so tiers are derived from the caller's inherited permissions instead. Owning the topic is not on its own evidence of creator-tier access to the project. -
Member chat with workspace/social scope: Returns empty array (no folders are mentionable)
Only active folders are returned. Supports both cursor-based and index-based pagination, plus name filtering.
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
The unique identifier of the chat
^[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
Optional partial name search filter (case-insensitive)
Sort order (1 for ascending, -1 for descending)
Default
{ "name": 1}Maximum number of results per page
value <= 10020Pagination type (cursor or index-based)
"index"Value in
- "cursor"
- "index"
Cursor for cursor-based pagination (only when paginate=cursor)
Reverse pagination direction (only when paginate=cursor)
falseInclude total counts (only when paginate=cursor)
falseInclude cursor record (only when paginate=cursor)
falsePage number (only when paginate=index)
1Response Body
application/json
curl -X GET "https://example.com/chats/497f6eca-6276-4993-bfeb-53cbbbba6f08/mentionable/folders"{ "page": 0, "limit": 0, "totalPages": 0, "totalResults": 0, "queryAt": 0, "results": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "ownerResourceId": "7d5ad1db-89f9-42df-868c-86a72347ae1c", "ownerResourceType": "project", "creatorId": "688ebf54-d343-4104-8711-82c2feac534a", "creator": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "firstName": "string", "lastName": "string", "displayName": "string", "avatar": "01d8bd6c-6014-46aa-b5b1-14d337c9c779", "color": "string", "awards": [ "staff" ], "accountType": "standard" }, "publisherId": "f1ba8124-cabe-46cd-b4f9-1189594ff7b3", "inheritanceId": "09c886ac-e6e5-4263-a494-a6e14f7e4f46", "iconId": "c0509817-d277-4b5a-94fe-4bd502bfe54c", "icon": "bc9b3dc5-578a-4929-a13c-7d1a9725e2b0", "color": "string", "name": "string", "slug": "string", "fileSystemPaths": [ "string" ], "basePath": "string", "visibility": "creator", "noFileSystem": false, "tags": [], "status": "active", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ]}