Skip to Content
Document comments

List comment threads on a document

GET
/api/v1/documents/{id}/comments

Returns the comment threads on a document, newest first. Each item is a thread: the comment that opened it and its replies are in messages. Filter by status (OPEN or RESOLVED), or omit it for both.

Authorization

headerAuthorizationBearer <token>

API key, e.g. Authorization: Bearer sajn_svc_.... Not scope-limited: acts with its owner's workspace role.

Path Parameters

id*string

The document ID.

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 100. Default: 25.

Range1 <= value <= 100
Default25
cursor?string

The nextCursor from the previous response, to get the next page. Keep the other parameters unchanged.

Length1 <= length <= 2048
include?array<>

total adds the number of items that match the filters. Counting takes time, so ask for it only when you need it.

status?string

Filter by thread status. Omit for both.

Value in"OPEN""RESOLVED"
createdAfter?string

Only threads created at or after this ISO 8601 date or date-time.

createdBefore?string

Only threads created at or before this ISO 8601 date or date-time.

updatedAfter?string

Only threads updated at or after this ISO 8601 date or date-time. Use it for incremental sync.

updatedBefore?string

Only threads updated at or before this ISO 8601 date or date-time.

Header Parameters

Sajn-Version?string

API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.

Value in"2026-09""2026-10"
Sajn-Workspace?string

ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.

Response Body

200

application/json
  1. response
data*array<>
hasMore*boolean

True if more items follow this page.

nextCursor*|

Pass this as cursor to get the next page. Null on the last page.

total?integer

The number of items that match the filters. Present only with include=total.

Range-9007199254740991 <= value <= 9007199254740991
Example Request
curl -X GET 'https://app.sajn.se/api/v1/documents/cm4k2x9p10003abcd1234efgh/comments'
Example Response
{  "data": [    {      "id": "cm4k2x9p10018abcd1234efgh",      "documentId": "cm4k2x9p10003abcd1234efgh",      "status": "OPEN",      "visibility": "INTERNAL",      "excerpt": "Anställningen börjar den 1 november 2026",      "createdAt": "2026-09-28T09:12:00.000Z",      "updatedAt": "2026-09-28T09:15:00.000Z",      "resolvedAt": null,      "createdBy": {        "id": "cm4k2x9p10002abcd1234efgh",        "name": "Alex Berg",        "email": "alex@example.com"      },      "resolvedBy": null,      "messages": [        {          "id": "cm4k2x9p10019abcd1234efgh",          "threadId": "cm4k2x9p10018abcd1234efgh",          "parentId": "cm4k2x9p10019abcd1234efgh",          "body": "Kan vi ändra startdatum till den 1 december?",          "mentions": [            "cm4k2x9p10002abcd1234efgh"          ],          "createdAt": "2026-09-28T09:12:00.000Z",          "editedAt": null,          "deletedAt": null,          "author": {            "type": "USER",            "id": "cm4k2x9p10002abcd1234efgh",            "name": "Alex Berg",            "email": "alex@example.com"          }        }      ]    }  ],  "hasMore": false,  "nextCursor": null,  "total": 1}

Was this page helpful?