List comments
Lists comment threads on a document.
GET
/v1/documents/:id/comments
Permission
The key must be granted docs.comments.read
A key without it gets 403 insufficient_scope, with the missing permission named in details.
Resolved threads are included by default, which is the opposite of the editor's sidebar: an integration auditing a document wants the whole history rather than the open half.
Path parameters
| Field | Type | Description |
|---|---|---|
id required |
string | The document whose comments to read. |
Query parameters
| Field | Type | Description |
|---|---|---|
include_resolved |
boolean |
false hides closed threads.
Defaults to true
|
Request
curl https://api.veruapis.com/v1/documents/:id/comments?include_resolved=false \
-H "Authorization: Bearer vak_live_..."Response
| Field | Type | Description |
|---|---|---|
id |
string | |
document_id |
string | |
parent_id |
string | Set on a reply, absent on a thread's first comment. |
author_id |
string | |
body |
string | |
state |
string |
openresolved
|
created_at |
RFC 3339 | |
updated_at |
RFC 3339 |
{
"data": [
{ "id": "0192d001-0000-7a41-b8d2-5e9f0c3a7b41", "document_id": "0192a1c2-6f3e-7a41-b8d2-5e9f0c3a7b41", "author_id": "01918e4b-9999-7f11-b4a9-0242ac130003", "body": "The North figure looks wrong", "state": "open", "created_at": "2026-09-08T14:00:00Z", "updated_at": "2026-09-08T14:00:00Z" },
{ "id": "0192d002-0000-7a41-b8d2-5e9f0c3a7b41", "document_id": "0192a1c2-6f3e-7a41-b8d2-5e9f0c3a7b41", "parent_id": "0192d001-0000-7a41-b8d2-5e9f0c3a7b41", "author_id": "01918e4b-7c2e-7f11-b4a9-0242ac130003", "body": "Fixed, thanks", "state": "open", "created_at": "2026-09-08T15:00:00Z", "updated_at": "2026-09-08T15:00:00Z" }
],
"meta": { "request_id": "req_01j8z9...", "timestamp": "2026-09-02T10:00:00Z" },
"pagination": { "next_cursor": "eyJ1aWQiOjQyMTF9", "has_more": true, "limit": 25 }
}
Worth knowing
Resolved threads are included unless you say otherwise, which is the opposite of the editor sidebar: an integration auditing a document wants the whole history.
Errors
Every failure uses the same shape, with a stable string code you can branch on. See the error reference.
Related
- POST Copy a document
- POST Post a comment
- POST Create a document
- DELETE Delete a comment
- DELETE Delete a document
- GET Get a document
- GET List documents
- POST Restore a document
- PATCH Edit or resolve a comment
- PATCH Update a document