List a file’s comments
Regional
us.api.brault.app— follows the region selector in the top barOldest first. Filter with resolved and version_id. format=csv answers text/csv with every matching comment and its replies, ignoring limit and cursor. A page (file_type canvas) is a valid file here; a page comment anchors to the page as a whole.
Authorization
apiKey AuthorizationBearer <token>
API key from Settings → Developers
In: header
Path Parameters
fileId*string
Query Parameters
limit?number
Range
1 <= value <= 100Default
50cursor?string
Opaque cursor from a previous response.
resolved?boolean
true for resolved only, false for open only; absent for all.
version_id?string
Only comments anchored to that version of this file.
format?string
csv answers text/csv; limit and cursor are ignored.
Default
"json"Value in
- "json"
- "csv"
Response Body
application/json
curl -X GET "https://example.com/v1/files/string/comments"{ "object": "list", "has_more": true, "next_cursor": "string", "data": [ { "object": "comment", "id": "string", "file_id": "string", "version_id": "string", "text": "string", "author": { "id": "string", "name": "string" }, "anonymous_name": "string", "mentions": [ { "id": "string", "name": "string" } ], "timestamp_ms": 0, "annotations": [ { "type": "draw", "coordinates": [ { "x": 0, "y": 0 } ] } ], "resolved": true, "resolved_at": "2019-08-24T14:15:22Z", "resolved_by_id": "string", "has_replies": true, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "edited_at": "2019-08-24T14:15:22Z" } ]}