New: AI Insights are here.
See what your users are asking.
⌘Ctrlk
Pricing Log in Sign up
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Space comments

Integrate and manage user comments in a space.

Comments are a powerful way to gather feedback on your documentation. Use this API to post, list, update, or delete comments and keep conversations organized.

The Comment object

Attributes
and
anyOptional
or

The Comment object

List all top-level comments posted on a space

get

Returns a paginated list of comments posted directly on the space (not inside a change request). To read replies to a specific comment, use the comment replies endpoint.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
spaceIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
Query parameters
pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

orderstring · enumOptional

An order for the items in the list

Default: descPossible values:
statusstring · enumOptional

When provided, only comments with the given status are returned. Defaults to "all".

Default: allPossible values:
formatstring · enumOptional

Output format for the content.

Possible values:
targetPagestringOptional

The target page of the comment

authorsstring[]Optional

User IDs to filter queried comments on

Responses
200

OK

application/json
countnumberOptional

Total count of objects in the list

get/spaces/{spaceId}/comments
200

OK

Post a new comment on a space or a specific page

post

Creates a new top-level comment on the space, optionally anchored to a specific page or a text selection within a page. Use this to leave feedback, start a review thread, or annotate content. To reply to an existing comment, use the comment replies endpoint.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
spaceIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
Body
nodestringOptional

The node to which the comment is posted, if any.

pagestringOptional

The page to which the comment is posted, if any.

bodyone ofRequired

The content of the comment.

or
or
object · EmptyOptional
Responses
200

The comment was posted.

application/json
and
anyOptional
or
post/spaces/{spaceId}/comments
200

The comment was posted.

Get a single comment from a space by its ID

get

Returns a specific comment posted on a space. To list all comments in a space, use the space comments list endpoint.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
spaceIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
commentIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
Query parameters
formatstring · enumOptional

Output format for the content.

Possible values:
Responses
200

The returned comment.

application/json
and
anyOptional
or
get/spaces/{spaceId}/comments/{commentId}
200

The returned comment.

Update the body or status of a space comment

put

Updates the content or resolution status of an existing comment on a space. Only the comment author or a space admin can update a comment. Use this to edit a comment's text, mark it as resolved, or reopen it.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
spaceIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
commentIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
Body
resolvedbooleanOptional

Whether the comment is resolved or not.

bodyone ofOptional

Content of the comment.

or
or
object · EmptyOptional
addedReactionsstring[]Optional

Reactions to add to the comment.

removedReactionsstring[]Optional

Reactions to remove from the comment.

Responses
200

The comment was updated.

application/json
and
anyOptional
or
put/spaces/{spaceId}/comments/{commentId}
200

The comment was updated.

Delete a space comment

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
spaceIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
commentIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
Responses
delete/spaces/{spaceId}/comments/{commentId}
No content

Post a reply to an existing space comment

post

Creates a reply to an existing comment on a space. Use this to continue a discussion thread started by a top-level comment. To start a new thread, use the space comment creation endpoint instead.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
spaceIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
commentIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
Body
bodyone ofRequired

The content of the comment.

or
or
object · EmptyOptional
Responses
200

The reply was posted.

application/json
objectstring · enumRequired

Type of Object, always equals to "comment-reply"

Possible values:
idstringRequired

Unique identifier for the reply.

postedAtstring · date-timeRequired
editedAtstring · date-timeOptional

Date when the reply was edited, if it has been edited.

bodyone ofRequired
or
or
object · EmptyOptional
post/spaces/{spaceId}/comments/{commentId}/replies
200

The reply was posted.

Get a single reply to a space comment by its ID

get

Returns a specific reply to a comment in a space. To list all replies for a comment, use the comment replies list endpoint.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
spaceIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
commentIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
commentReplyIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
Query parameters
formatstring · enumOptional

Output format for the content.

Possible values:
Responses
200

The returned comment reply.

application/json
objectstring · enumRequired

Type of Object, always equals to "comment-reply"

Possible values:
idstringRequired

Unique identifier for the reply.

postedAtstring · date-timeRequired
editedAtstring · date-timeOptional

Date when the reply was edited, if it has been edited.

bodyone ofRequired
or
or
object · EmptyOptional
get/spaces/{spaceId}/comments/{commentId}/replies/{commentReplyId}
200

The returned comment reply.

Update the body of a reply to a space comment

put

Updates the content of an existing reply to a comment in a space. Only the reply author or a space admin can update the reply. To update the parent comment, use the space comment update endpoint.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
spaceIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
commentIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
commentReplyIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
Body
bodyone ofOptional

Content of the comment.

or
or
object · EmptyOptional
addedReactionsstring[]Optional

Reactions to add to the comment.

removedReactionsstring[]Optional

Reactions to remove from the comment.

Responses
200

The reply was updated.

application/json
objectstring · enumRequired

Type of Object, always equals to "comment-reply"

Possible values:
idstringRequired

Unique identifier for the reply.

postedAtstring · date-timeRequired
editedAtstring · date-timeOptional

Date when the reply was edited, if it has been edited.

bodyone ofRequired
or
or
object · EmptyOptional
put/spaces/{spaceId}/comments/{commentId}/replies/{commentReplyId}
200

The reply was updated.

Delete a space comment reply

delete
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
spaceIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
commentIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
commentReplyIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
Responses
delete/spaces/{spaceId}/comments/{commentId}/replies/{commentReplyId}
No content

List all users who have posted comments in a space

get

Returns a paginated list of organization members who have posted at least one comment in the space. Use this to identify participants in a space's review or annotation workflow. For the actual comment content, use the space comments endpoint.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
spaceIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$
Query parameters
pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses
200

OK

application/json
countnumberOptional

Total count of objects in the list

get/spaces/{spaceId}/commenters
200

OK

Last updated

Was this helpful?

AltStyle によって変換されたページ (->オリジナル) /