---
title: "Get inline comments"
method: GET
path: "/inline-comments"
tags: ["Comment"]
---

# Get inline comments

`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](https://confluence.atlassian.com/x/_AozKw) required**:
Permission to view the content of the page and its corresponding space.

## 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.
- `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`.
- `cursor` string
- `limit` integer

## Response `200`

Returned if the requested inline comments are returned.

- object
  - `results` InlineCommentModel[]
    - `id` string — ID of the comment.
    - `status` 'current' | 'draft' | 'archived' | 'historical' | 'trashed' | 'deleted' | 'any' — The status of the content.
    - `title` string — Title of the comment.
    - `blogPostId` string — ID of the blog post containing the comment if the comment is on a blog post.
    - `pageId` string — ID of the page containing the comment if the comment is on a page.
    - `parentCommentId` string — ID of the parent comment if the comment is a reply.
    - `version` Version
      - `createdAt` string, date-time — Date and time when the version was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".
      - `message` string — Message associated with the current version.
      - `number` integer — The version number.
      - `minorEdit` boolean — Describes if this version is a minor version. Email notifications and activity stream updates are not created for minor versions.
      - `authorId` string — The account ID of the user who created this version.
    - `body` BodySingle — Contains fields for each representation type requested.
      - `storage` BodyType
        - `representation` string — Type of content representation used for the value field.
        - `value` string — Body of the content, in the format found in the representation field.
      - `atlas_doc_format` BodyType
        - `representation` string — Type of content representation used for the value field.
        - `value` string — Body of the content, in the format found in the representation field.
      - `view` BodyType
        - `representation` string — Type of content representation used for the value field.
        - `value` string — Body of the content, in the format found in the representation field.
    - `resolutionLastModifierId` string — Atlassian Account ID of last person who modified the resolve state of the comment. Null until comment is resolved or reopened.
    - `resolutionLastModifiedAt` string, 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
    - `properties` object
      - `results` ContentProperty[]
        - `id` string — ID of the property
        - `key` string — Key of the property
        - `value` unknown
        - `version` Version
          - `createdAt` string, date-time — Date and time when the version was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".
          - `message` string — Message associated with the current version.
          - `number` integer — The version number.
          - `minorEdit` boolean — Describes if this version is a minor version. Email notifications and activity stream updates are not created for minor versions.
          - `authorId` string — The account ID of the user who created this version.
      - `meta` OptionalFieldMeta
        - `hasMore` boolean — Indicates if there are more available results that can be fetched.
        - `cursor` string — A token that can be used in the query parameter of the endpoint returned in the `_links` property to retrieve the next set of results.
      - `_links` OptionalFieldLinks
        - `self` string — A relative URL that can be used to fetch results beyond what this include parameter retrieves.
      - `inlineMarkerRef` string — Property value used to reference the highlighted element in DOM.
      - `inlineOriginalSelection` string — Text that is highlighted.
    - `operations` object
      - `results` Operation[]
        - `operation` string — The type of operation.
        - `targetType` string — The type of entity the operation type targets.
      - `meta` OptionalFieldMeta
        - `hasMore` boolean — Indicates if there are more available results that can be fetched.
        - `cursor` string — A token that can be used in the query parameter of the endpoint returned in the `_links` property to retrieve the next set of results.
      - `_links` OptionalFieldLinks
        - `self` string — A relative URL that can be used to fetch results beyond what this include parameter retrieves.
    - `likes` object
      - `results` Like[]
        - `accountId` string — Account ID.
      - `meta` OptionalFieldMeta
        - `hasMore` boolean — Indicates if there are more available results that can be fetched.
        - `cursor` string — A token that can be used in the query parameter of the endpoint returned in the `_links` property to retrieve the next set of results.
      - `_links` OptionalFieldLinks
        - `self` string — A relative URL that can be used to fetch results beyond what this include parameter retrieves.
    - `versions` object
      - `results` Version[]
        - `createdAt` string, date-time — Date and time when the version was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".
        - `message` string — Message associated with the current version.
        - `number` integer — The version number.
        - `minorEdit` boolean — Describes if this version is a minor version. Email notifications and activity stream updates are not created for minor versions.
        - `authorId` string — The account ID of the user who created this version.
      - `meta` OptionalFieldMeta
        - `hasMore` boolean — Indicates if there are more available results that can be fetched.
        - `cursor` string — A token that can be used in the query parameter of the endpoint returned in the `_links` property to retrieve the next set of results.
      - `_links` OptionalFieldLinks
        - `self` string — A relative URL that can be used to fetch results beyond what this include parameter retrieves.
    - `_links` CommentLinks
      - `webui` string — Web UI link of the content.
  - `_links` MultiEntityLinks
    - `next` string — Used for pagination. Contains the relative URL for the next set of results, using a cursor query parameter. This property will not be present if there is no additional data available.
    - `base` string — Base url of the Confluence site.

## Other responses

- `400` — Returned if an invalid request is provided.
- `401` — Returned if the authentication credentials are incorrect or missing from the request.

---

[API](https://skmtc.net/atlassian/apis/the-confluence-cloud-rest-api-v2.md) · [All operations](https://skmtc.net/atlassian/apis/the-confluence-cloud-rest-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-confluence-cloud-rest-api-v2/revisions/c4bd1ed570f2/schema)