Confluence Like API

openapi: 3.2.0
info:
  title: Confluence Cloud REST API v2 Like API
  description: This document describes Confluence's v2 APIs. This is intended to be an iteration on the existing Confluence Cloud REST API with improvements in both endpoint definitions and performance.
  termsOfService: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/
  version: 2.0.0
servers:
- url: https://{your-domain}/wiki/api/v2
  variables:
    your-domain:
      default: no-default
      description: Specific domain of the Confluence site being used. Must be provided.
tags:
- name: Like
  description: ''
paths:
  /blogposts/{id}/likes/count:
    get:
      tags:
      - Like
      operationId: getBlogPostLikeCount
      summary: Get like count for blog post
      description: 'Returns the count of likes of specific blog post.


        **Permissions required**:

        Permission to view the content of the blog post and its corresponding space.'
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the blog post for which like count should be returned.
        schema:
          format: int64
          type: integer
      responses:
        '200':
          description: Returned if the requested count is returned.
          content:
            application/json:
              schema:
                title: Integer
                type: object
                properties:
                  count:
                    type: integer
                    format: int64
                    description: The count number
        '400':
          description: Returned if an invalid request is provided.
          content: {}
        '401':
          description: 'Returned if the authentication credentials are incorrect or missing

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            requested blog post or the blog post was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:page:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:page:confluence
      x-atlassian-connect-scope: READ
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /blogposts/{id}/likes/users:
    get:
      tags:
      - Like
      operationId: getBlogPostLikeUsers
      summary: Get account IDs of likes for blog post
      description: 'Returns the account IDs of likes of specific blog post.


        **Permissions required**:

        Permission to view the content of the blog post and its corresponding space.'
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the blog post for which account IDs should be returned.
        schema:
          format: int64
          type: integer
      - name: cursor
        in: query
        required: false
        description: 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.
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of account IDs 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.
        schema:
          format: int32
          default: 25
          minimum: 0
          maximum: 250
          type: integer
      responses:
        '200':
          description: Returned if the requested account IDs are returned.
          content:
            application/json:
              schema:
                title: MultiEntityResult<String>
                type: object
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Like'
                  _links:
                    $ref: '#/components/schemas/MultiEntityLinks'
          headers:
            Link:
              schema:
                type: string
              description: 'This header contains URL(s) within angle brackets and a relation description for each URL, describing how the provided URL relates to the incoming request''s URL. For example, rel="next" would be the URL necessary to get the next page of information. Example response header format: `Link: </wiki/api/v2/blogposts/<id>/likes/users?cursor=<opaque cursor token>>; rel="next", <https://site.atlassian.net/wiki>; rel="base"`

                '
        '400':
          description: Returned if an invalid request is provided.
          content: {}
        '401':
          description: 'Returned if the authentication credentials are incorrect or missing

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            requested blog post or the blog post was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:page:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:page:confluence
      x-atlassian-connect-scope: READ
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /pages/{id}/likes/count:
    get:
      tags:
      - Like
      operationId: getPageLikeCount
      summary: Get like count for page
      description: 'Returns the count of likes of specific page.


        **Permissions required**:

        Permission to view the content of the page and its corresponding space.'
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the page for which like count should be returned.
        schema:
          format: int64
          type: integer
      responses:
        '200':
          description: Returned if the requested count is returned.
          content:
            application/json:
              schema:
                title: Integer
                type: object
                properties:
                  count:
                    type: integer
                    format: int64
                    description: The count number
        '400':
          description: Returned if an invalid request is provided.
          content: {}
        '401':
          description: 'Returned if the authentication credentials are incorrect or missing

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            requested page or the page was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:page:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:page:confluence
      x-atlassian-connect-scope: READ
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /pages/{id}/likes/users:
    get:
      tags:
      - Like
      operationId: getPageLikeUsers
      summary: Get account IDs of likes for page
      description: 'Returns the account IDs of likes of specific page.


        **Permissions required**:

        Permission to view the content of the page and its corresponding space.'
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the page for which like count should be returned.
        schema:
          format: int64
          type: integer
      - name: cursor
        in: query
        required: false
        description: 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.
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of account IDs 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.
        schema:
          format: int32
          default: 25
          minimum: 0
          maximum: 250
          type: integer
      responses:
        '200':
          description: Returned if the requested account IDs are returned.
          content:
            application/json:
              schema:
                title: MultiEntityResult<String>
                type: object
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Like'
                  _links:
                    $ref: '#/components/schemas/MultiEntityLinks'
          headers:
            Link:
              schema:
                type: string
              description: 'This header contains URL(s) within angle brackets and a relation description for each URL, describing how the provided URL relates to the incoming request''s URL. For example, rel="next" would be the URL necessary to get the next page of information. Example response header format: `Link: </wiki/api/v2/pages/<id>/likes/users?cursor=<opaque cursor token>>; rel="next", <https://site.atlassian.net/wiki>; rel="base"`

                '
        '400':
          description: Returned if an invalid request is provided.
          content: {}
        '401':
          description: 'Returned if the authentication credentials are incorrect or missing

            from the request.'
          content: {}
        '404':
          description: 'Returned if the calling user does not have permission to view the

            requested page or the page was not found.'
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:page:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:page:confluence
      x-atlassian-connect-scope: READ
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /footer-comments/{id}/likes/count:
    get:
      tags:
      - Like
      operationId: getFooterLikeCount
      summary: Get like count for footer comment
      description: 'Returns the count of likes of specific footer comment.


        **Permissions required**:

        Permission to view the content of the page/blogpost and its corresponding space.'
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the footer comment for which like count should be returned.
        schema:
          format: int64
          type: integer
      responses:
        '200':
          description: Returned if the requested count is returned.
          content:
            application/json:
              schema:
                title: Integer
                type: object
                properties:
                  count:
                    type: integer
                    format: int64
                    description: The count number
        '400':
          description: Returned if an invalid request is provided.
          content: {}
        '401':
          description: 'Returned if the authentication credentials are incorrect or missing

            from the request.'
          content: {}
        '404':
          description: Returned if the calling user does not have permission to view the comment or the comment was not found.
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:comment:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:comment:confluence
      x-atlassian-connect-scope: READ
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /footer-comments/{id}/likes/users:
    get:
      tags:
      - Like
      operationId: getFooterLikeUsers
      summary: Get account IDs of likes for footer comment
      description: 'Returns the account IDs of likes of specific footer comment.


        **Permissions required**:

        Permission to view the content of the page/blogpost and its corresponding space.'
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the footer comment for which like count should be returned.
        schema:
          format: int64
          type: integer
      - name: cursor
        in: query
        required: false
        description: 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.
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of account IDs 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.
        schema:
          format: int32
          default: 25
          minimum: 0
          maximum: 250
          type: integer
      responses:
        '200':
          description: Returned if the requested account IDs are returned.
          content:
            application/json:
              schema:
                title: MultiEntityResult<String>
                type: object
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Like'
                  _links:
                    $ref: '#/components/schemas/MultiEntityLinks'
          headers:
            Link:
              schema:
                type: string
              description: 'This header contains URL(s) within angle brackets and a relation description for each URL, describing how the provided URL relates to the incoming request''s URL. For example, rel="next" would be the URL necessary to get the next page of information. Example response header format: `Link: </wiki/api/v2/footer-comments/<id>/likes/users?cursor=<opaque cursor token>>; rel="next", <https://site.atlassian.net/wiki>; rel="base"`

                '
        '400':
          description: Returned if an invalid request is provided.
          content: {}
        '401':
          description: 'Returned if the authentication credentials are incorrect or missing

            from the request.'
          content: {}
        '404':
          description: Returned if the calling user does not have permission to view the comment or the comment was not found.
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:comment:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:comment:confluence
      x-atlassian-connect-scope: READ
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /inline-comments/{id}/likes/count:
    get:
      tags:
      - Like
      operationId: getInlineLikeCount
      summary: Get like count for inline comment
      description: 'Returns the count of likes of specific inline comment.


        **Permissions required**:

        Permission to view the content of the page/blogpost and its corresponding space.'
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the inline comment for which like count should be returned.
        schema:
          format: int64
          type: integer
      responses:
        '200':
          description: Returned if the requested count is returned.
          content:
            application/json:
              schema:
                title: Integer
                type: object
                properties:
                  count:
                    type: integer
                    format: int64
                    description: The count number
        '400':
          description: Returned if an invalid request is provided.
          content: {}
        '401':
          description: 'Returned if the authentication credentials are incorrect or missing

            from the request.'
          content: {}
        '404':
          description: Returned if the calling user does not have permission to view the comment or the comment was not found.
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:comment:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:comment:confluence
      x-atlassian-connect-scope: READ
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
  /inline-comments/{id}/likes/users:
    get:
      tags:
      - Like
      operationId: getInlineLikeUsers
      summary: Get account IDs of likes for inline comment
      description: 'Returns the account IDs of likes of specific inline comment.


        **Permissions required**:

        Permission to view the content of the page/blogpost and its corresponding space.'
      parameters:
      - name: id
        in: path
        required: true
        description: The ID of the inline comment for which like count should be returned.
        schema:
          format: int64
          type: integer
      - name: cursor
        in: query
        required: false
        description: 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.
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of account IDs 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.
        schema:
          format: int32
          default: 25
          minimum: 0
          maximum: 250
          type: integer
      responses:
        '200':
          description: Returned if the requested account IDs are returned.
          content:
            application/json:
              schema:
                title: MultiEntityResult<String>
                type: object
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/Like'
                  _links:
                    $ref: '#/components/schemas/MultiEntityLinks'
          headers:
            Link:
              schema:
                type: string
              description: 'This header contains URL(s) within angle brackets and a relation description for each URL, describing how the provided URL relates to the incoming request''s URL. For example, rel="next" would be the URL necessary to get the next page of information. Example response header format: `Link: </wiki/api/v2/inline-comments/<id>/likes/users?cursor=<opaque cursor token>>; rel="next", <https://site.atlassian.net/wiki>; rel="base"`

                '
        '400':
          description: Returned if an invalid request is provided.
          content: {}
        '401':
          description: 'Returned if the authentication credentials are incorrect or missing

            from the request.'
          content: {}
        '404':
          description: Returned if the calling user does not have permission to view the comment or the comment was not found.
          content: {}
      security:
      - basicAuth: []
      - oAuthDefinitions:
        - read:comment:confluence
      x-atlassian-oauth2-scopes:
      - scheme: oAuthDefinitions
        state: Current
        scopes:
        - read:comment:confluence
      x-atlassian-connect-scope: READ
      x-atlassian-data-security-policy:
      - app-access-rule-exempt: false
components:
  schemas:
    Like:
      type: object
      properties:
        accountId:
          type: string
          description: Account ID.
    MultiEntityLinks:
      type: object
      properties:
        next:
          type: string
          description: '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:
          type: string
          description: Base url of the Confluence site.
  securitySchemes:
    basicAuth:
      type: http
      description: You can access this resource via basic auth.
      scheme: basic
    oAuthDefinitions:
      type: oauth2
      description: This API uses OAuth 2 with the authorizationCode grant flow.
      flows:
        authorizationCode:
          authorizationUrl: https://auth.atlassian.com/authorize
          tokenUrl: https://auth.atlassian.com/oauth/token
          scopes:
            read:page:confluence: View pages and blogposts and their properties.
            read:space:confluence: View spaces and their properties.
            read:attachment:confluence: View attachments and their properties.
            read:comment:confluence: View comments and their properties.
            read:custom-content:confluence: View custom content and their properties.
            read:task:confluence: View tasks.
            read:whiteboard:confluence: View whiteboards and their properties.
            read:database:confluence: View databases and their properties.
            read:embed:confluence: View Smart Links in the content tree and their properties.
            read:folder:confluence: View folders and their properties.
            read:hierarchical-content:confluence: View children and descendants in the content tree.
            write:space:confluence: Create and update spaces and their properties.
            write:page:confluence: Create and update pages and blog posts and their properties.
            write:comment:confluence: Create and update comments and their properties.
            write:custom-content:confluence: Create and update custom content and their properties.
            write:whiteboard:confluence: Create and update whiteboards and their properties.
            write:database:confluence: Create and update databases and their properties.
            write:embed:confluence: Create and update Smart Links in the content tree and their properties.
            write:folder:confluence: Create and update folders and their properties.
            write:app-data:confluence: Create, update and delete app properties.
            delete:custom-content:confluence: Delete custom content.
            delete:page:confluence: Delete pages and blog posts.
            delete:comment:confluence: Delete comments.
            delete:whiteboard:confluence: Delete whiteboards.
            delete:database:confluence: Delete databases.
            delete:embed:confluence: Delete Smart Links in the content tree.
            delete:folder:confluence: Delete folders.
externalDocs:
  description: The online and complete version of the Confluence Cloud REST API docs.
  url: https://developer.atlassian.com/cloud/confluence/rest/v2
x-atlassian-narrative:
  documents:
  - title: About
    anchor: about
    body: This is the reference for the Confluence Cloud REST API v2, with definitions and performance intended to be an improvement over v1. You can click on the meatball menu in the upper right to download the spec or Postman collection.
  - title: Authentication and authorization
    anchor: auth
    body: '**Authentication:** If you are building a Cloud app, authentication is implemented via JWT or Oauth 2.0, depending on what you''re building (see [Authentication for apps](https://developer.atlassian.com/cloud/confluence/authentication-for-apps/)). Otherwise, if you are authenticating directly against the REST API, the REST API supports basic auth (see [Basic auth for REST APIs](https://developer.atlassian.com/cloud/confluence/basic-auth-for-rest-apis/)).


      **Authorization:** If you are building a Cloud app, authorization can be implemented by [scopes](https://developer.atlassian.com/cloud/confluence/scopes/) or by [OAuth 2.0 user impersonation](https://developer.atlassian.com/cloud/confluence/oauth-2-jwt-bearer-tokens-for-apps). Otherwise, if you are making calls directly against the REST API, authorization is based on the user used in the authentication process.


      See [Security overview](https://developer.atlassian.com/cloud/confluence/security-overview/) for more details on authentication and authorization.'
  - title: Using the REST API
    anchor: using
    body: "**Pagination:** The Confluence REST API v2 uses cursor-based pagination: a method that returns a response with multiple objects can only return a limited number at one time. This limits the size of responses and conserves server resources.\n\nUse the 'limit' and 'cursor' parameters on endpoints that return multiple objects to work with pagination. First, make a request with your desired limit in the 'limit' parameter, then observe the `Link` header in the response. If there are additional entities to be retrieved, the `next` URL in the `Link` header will allow you to retrieve the next set of results. This relative URL will also be available under the `_links.next` property of paginated responses. \n\nFor example, the following request will return 5 page objects (if there are 5 present in the target site).\n```\nGET /wiki/api/v2/pages?limit=5\n```\n\nIf there are additional pages available, the `Link` header will look like:\n```\n</wiki/api/v2/pages?limit=5&cursor=<cursor token>>; rel=\"next\"\n```\nThe URL within the `Link` header will allow you to access the next 5 pages, while the `rel=\"next\"` denotes that the URL refers to the \"next\" set of pages. Relations for a single URL are separated by semicolons (;) and URLs are separated by commas (,)\nIf there are no related URLs, the `Link` header will not be present in the response and neither will the `next` property for `_links` in the response body."