Audit
Content
Content - attachments
Content body
Content - children and descendants
Content - macro body
Content comments
Content labels
Content permissions
Content properties
Content restrictions
Content versions
Content watches
Dynamic modules
Experimental
Group
Inline tasks
Label info
Long-running task
Relation
Search
Settings
Space
Space permissions
Space properties
Space settings
Template
Themes
Users

Rate this page:

Content comments

Get content comments

GET /wiki/rest/api/content/{id}/child/comment

Returns the comments on a piece of content.

Permissions required: 'View' permission for the space, and permission to view the content if it is a page.

Connect app scope requiredREAD

OAuth scopes required
read:confluence-content.summary

Request

Path parameters
id Required

string

The ID of the content to be queried for its comments.

Query parameters
expand

Array<string>

A multi-value parameter indicating which properties of the content to expand.

In addition, the following comment-specific expansions can be used:

  • extensions.inlineProperties returns inline comment-specific properties.
  • extensions.resolution returns the resolution status of each comment.
Style: form
parentVersion

integer

The version of the parent content to retrieve children for. Currently, this only works for the latest version.

Default: 0, Minimum: 0, Format: int32
start

integer

The starting index of the returned comments.

Format: int32
limit

integer

The maximum number of comments to return per page. Note, this may be restricted by fixed system limits.

Default: 25, Minimum: 0, Format: int32
location

Array<string>

The location of the comments in the page. Multiple locations can be specified. If no location is specified, comments from all locations are returned.

Style: form
depth

string

Currently, this parameter is not used. Comments are returned at the root level only.

Example

1
2
3
4
curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/content/{id}/child/comment' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

Returned if the requested comments are returned.

Content typeValue
application/json

ContentArray

Rate this page: