Skip to main content
GET
Get a comment thread

Authorizations

Authorization
string
header
required

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

Scopes

documents:read

Read documents.

Headers

Sajn-Version
enum<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.

Available options:
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.

Path Parameters

id
string
required

The document ID.

threadId
string
required

The comment thread ID.

Response

200

id
string
required

The comment thread ID.

documentId
string | null
required

The document ID.

status
enum<string>
required

Whether the thread is open or resolved.

Available options:
OPEN,
RESOLVED
visibility
enum<string>
required

If SHARED, every party on the document sees the thread. If INTERNAL, only the workspace does.

Available options:
INTERNAL,
SHARED
excerpt
string | null
required

The document text the thread refers to.

createdAt
string<date-time>
required

When the comment thread was created.

updatedAt
string<date-time>
required

When the comment thread was last updated.

resolvedAt
string<date-time> | null
required

When the thread was resolved. Null while it's open.

createdBy
object | null
required

Who wrote it. Null when the author no longer exists.

resolvedBy
object | null
required

Who wrote it. Null when the author no longer exists.

messages
object[]
required

The thread's messages, oldest first.