Docmost Octri Preview
POST/comments/info

Get a comment

Retrieves a comment by its identifier, including its creator and the user who resolved it. Supply commentId as a UUID to identify the comment.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 body field

The identifier of the comment to retrieve.

commentIdstringrequired
ID of the comment.

3 status codes
200Returns the comment with its creator and resolvedBy information.
dataobjectoptional
Comment with creator and resolvedBy user objects
statusintegeroptional
successbooleanoptional
403Returned when access to the comment is forbidden.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
404Returned when the comment does not exist.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

A 403 is returned when the authenticated user is not permitted to access the comment. A 404 is returned when no comment exists with the supplied commentId.