Skip to main content
GET
Error

Authorizations

X-API-Key
string
header
required

Headers

customer
string
required

Workspace identifier

Path Parameters

projectId
string
required
entityId
string
required

For a new thread, the item or branch ID. For replies, the ID of the original comment that started the conversation, even when responding to a later reply. For an existing comment, use its returned entity_id when fetching, editing or deleting it.

commentId
string
required

Response

200 - application/json
author_id
string
required

ID of the user who authored the comment.

created_at
string<date-time>
required
entity_id
string
required

ID this comment directly attaches to: an item or branch ID for a conversation starter, or a comment ID for a reply (normally the original comment that started the conversation). Use this value as entityId when fetching, editing or deleting this comment. For older nested replies it may identify another reply, not the conversation starter.

id
string
required
resolved
boolean
required

Whether the comment thread has been resolved.

text
string
required

Plain-text body of the comment.

branch_id
string

Branch the comment was posted on; absent for the main line.