Sign in

v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Comment

Get inline comment by id

Retrieves an inline comment by id

Permissions required: Permission to view the content of the page or blogpost and its corresponding space.

get/inline-comments/{comment-id}

Path parameters

comment-idinteger required

The ID of the comment to be retrieved.

Query parameters

body-format'storage' | 'atlas_doc_format' | 'view' | 'export_view' | 'anonymous_export_view' | 'styled_view' | 'editor'

The primary formats a body can be represented as. A subset of BodyRepresentation. These formats are the only allowed formats in certain use cases.

The content format type to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.

versioninteger

Allows you to retrieve a previously published version. Specify the previous version's number to retrieve its details.

include-propertiesboolean

Includes content properties associated with this inline comment in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

include-operationsboolean

Includes operations associated with this inline comment in the response, as defined in the Operation object. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

include-likesboolean

Includes likes associated with this inline comment in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

include-versionsboolean

Includes versions associated with this inline comment in the response. The number of results will be limited to 50 and sorted in the default sort order. A meta and _links property will be present to indicate if more results are available and a link to retrieve the rest of the results.

include-versionboolean

Includes the current version associated with this inline comment in the response. By default this is included and can be omitted by setting the value to false.

Response

Returned if the inline comment is successfully retrieved.

idstring

ID of the comment.

status'current' | 'draft' | 'archived' | 'historical' | 'trashed' | 'deleted' | 'any'

The status of the content.

titlestring

Title of the comment.

blogPostIdstring

ID of the blog post containing the comment if the comment is on a blog post.

pageIdstring

ID of the page containing the comment if the comment is on a page.

parentCommentIdstring

ID of the parent comment if the comment is a reply.

resolutionLastModifierIdstring

Atlassian Account ID of last person who modified the resolve state of the comment. Null until comment is resolved or reopened.

resolutionLastModifiedAtstring date-time

Timestamp of the last modification to the comment's resolution status. Null until comment is resolved or reopened.

resolutionStatus'open' | 'reopened' | 'resolved' | 'dangling'

Inline comment resolution status