v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Comment

Get inline comments

Returns all inline comments. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

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

get/inline-comments

Query parameters

body-format'storage' | 'atlas_doc_format'

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.

sort'created-date' | '-created-date' | 'modified-date' | '-modified-date'

The sort fields for comments. The default sort direction is ascending. To sort in descending order, append a - character before the sort field. For example, fieldName or -fieldName.

Used to sort the result by a particular field.

cursorstring

Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

limitinteger

Maximum number of footer comments per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

Response

Returned if the requested inline comments are returned.