Atlassian Confluence Content API — Get

naftiko: 1.0.0-alpha2
info:
  label: Atlassian Confluence Content API — Get
  description: 'Atlassian Confluence Content API — Get. 25 operations. Lead operation: Atlassian Get Content by Id. Self-contained
    Naftiko capability covering one Atlassian business surface.'
  tags:
  - Atlassian
  - Get
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ATLASSIAN_API_KEY: ATLASSIAN_API_KEY
capability:
  consumes:
  - type: http
    namespace: confluence-content-get
    baseUri: ''
    description: Atlassian Confluence Content API — Get business capability. Self-contained, no shared references.
    resources:
    - name: wiki-rest-api-content-id
      path: /wiki/rest/api/content/{id}
      operations:
      - name: getcontentbyid
        method: GET
        description: Atlassian Get Content by Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be returned. If you don't know the content ID,
          required: true
        - name: status
          in: query
          type: array
          description: Filter the results to a set of content based on their status.
        - name: version
          in: query
          type: integer
          description: The version number of the content to be returned.
        - name: embeddedContentRender
          in: query
          type: string
          description: The version of embedded content (e.g. attachments) to render.
        - name: trigger
          in: query
          type: string
          description: If set to `viewed`, the request will trigger a 'viewed' event for the content.
    - name: wiki-rest-api-content-id-child
      path: /wiki/rest/api/content/{id}/child
      operations:
      - name: getcontentchildren
        method: GET
        description: Atlassian Get Content Children
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its children.
          required: true
        - name: expand
          in: query
          type: array
          description: 'A multi-value parameter indicating which properties of the children to expand, where:'
        - name: parentVersion
          in: query
          type: integer
          description: The version of the parent content to retrieve children for.
    - name: wiki-rest-api-content-id-child-attachment
      path: /wiki/rest/api/content/{id}/child/attachment
      operations:
      - name: getattachments
        method: GET
        description: Atlassian Get Attachments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its attachments.
          required: true
        - name: start
          in: query
          type: integer
          description: The starting index of the returned attachments.
        - name: limit
          in: query
          type: integer
          description: The maximum number of attachments to return per page.
        - name: filename
          in: query
          type: string
          description: Filter the results to attachments that match the filename.
        - name: mediaType
          in: query
          type: string
          description: Filter the results to attachments that match the media type.
    - name: wiki-rest-api-content-id-child-attachment-attachmentId-download
      path: /wiki/rest/api/content/{id}/child/attachment/{attachmentId}/download
      operations:
      - name: geturitodownloadattachment
        method: GET
        description: Atlassian Get Uri to Download Attachment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content that the attachment is attached to.
          required: true
        - name: attachmentId
          in: path
          type: string
          description: The ID of the attachment to download.
          required: true
        - name: version
          in: query
          type: integer
          description: The version of the attachment. If this parameter is absent, the redirect URI will download the latest
            version of the attachment.
    - name: wiki-rest-api-content-id-child-comment
      path: /wiki/rest/api/content/{id}/child/comment
      operations:
      - name: getcontentcomments
        method: GET
        description: Atlassian Get Content Comments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its comments.
          required: true
        - name: parentVersion
          in: query
          type: integer
          description: The version of the parent content to retrieve children for.
        - name: start
          in: query
          type: integer
          description: The starting index of the returned comments.
        - name: limit
          in: query
          type: integer
          description: The maximum number of comments to return per page. Note,
        - name: location
          in: query
          type: array
          description: The location of the comments in the page. Multiple locations can be specified.
        - name: depth
          in: query
          type: string
          description: Currently, this parameter is not used.
    - name: wiki-rest-api-content-id-child-type
      path: /wiki/rest/api/content/{id}/child/{type}
      operations:
      - name: getcontentchildrenbytype
        method: GET
        description: Atlassian Get Content Children by Type
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its children.
          required: true
        - name: type
          in: path
          type: string
          description: The type of children to return.
          required: true
        - name: parentVersion
          in: query
          type: integer
          description: The version of the parent content to retrieve children for.
        - name: start
          in: query
          type: integer
          description: The starting index of the returned content.
        - name: limit
          in: query
          type: integer
          description: The maximum number of content to return per page. Note,
    - name: wiki-rest-api-content-id-descendant
      path: /wiki/rest/api/content/{id}/descendant
      operations:
      - name: getcontentdescendants
        method: GET
        description: Atlassian Get Content Descendants
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its descendants.
          required: true
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the children to
    - name: wiki-rest-api-content-id-history
      path: /wiki/rest/api/content/{id}/history
      operations:
      - name: getcontenthistory
        method: GET
        description: Atlassian Get Content History
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its history.
          required: true
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the content history to expand.
    - name: wiki-rest-api-content-id-history-version-macro-id-macroId
      path: /wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}
      operations:
      - name: getmacrobodybymacroid
        method: GET
        description: Atlassian Get Macro Body by Macro Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID for the content that contains the macro.
          required: true
        - name: version
          in: path
          type: integer
          description: The version of the content that contains the macro. Specifying `0` as the `version` will return
          required: true
        - name: macroId
          in: path
          type: string
          description: The ID of the macro. This is usually passed by the app that the
          required: true
    - name: wiki-rest-api-content-id-history-version-macro-id-macroId-convert-async-to
      path: /wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}/convert/async/{to}
      operations:
      - name: getmacrobodybymacroidandconvertrepresentationasynchronously
        method: GET
        description: Atlassian Get Macro Body by Macro Id and Convert Representation Asynchronously
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID for the content that contains the macro.
          required: true
        - name: version
          in: path
          type: integer
          description: The version of the content that contains the macro. Specifying `0` as the `version` will return
          required: true
        - name: macroId
          in: path
          type: string
          description: The ID of the macro. For apps, this is passed to the macro by the Connect/Forge framework.
          required: true
        - name: to
          in: path
          type: string
          description: The content representation to return the macro in.
          required: true
        - name: allowCache
          in: query
          type: boolean
          description: If this field is false, the cache will erase its current value and begin a conversion.
        - name: spaceKeyContext
          in: query
          type: string
          description: The space key used for resolving embedded content (page includes,
        - name: embeddedContentRender
          in: query
          type: string
          description: Mode used for rendering embedded content, like attachments.
    - name: wiki-rest-api-content-id-history-version-macro-id-macroId-convert-to
      path: /wiki/rest/api/content/{id}/history/{version}/macro/id/{macroId}/convert/{to}
      operations:
      - name: getmacrobodybymacroidandconverttherepresentationsynchronously
        method: GET
        description: Atlassian Get Macro Body by Macro Id and Convert the Representation Synchronously
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID for the content that contains the macro.
          required: true
        - name: version
          in: path
          type: integer
          description: The version of the content that contains the macro. Specifying `0` as the `version` will return
          required: true
        - name: macroId
          in: path
          type: string
          description: The ID of the macro. This is usually passed by the app that the
          required: true
        - name: to
          in: path
          type: string
          description: The content representation to return the macro in.
          required: true
        - name: spaceKeyContext
          in: query
          type: string
          description: The space key used for resolving embedded content (page includes,
        - name: embeddedContentRender
          in: query
          type: string
          description: Mode used for rendering embedded content, like attachments.
    - name: wiki-rest-api-content-id-label
      path: /wiki/rest/api/content/{id}/label
      operations:
      - name: getlabelsforcontent
        method: GET
        description: Atlassian Get Labels for Content
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its labels.
          required: true
        - name: prefix
          in: query
          type: string
          description: Filters the results to labels with the specified prefix. If this parameter
        - name: start
          in: query
          type: integer
          description: The starting index of the returned labels.
        - name: limit
          in: query
          type: integer
          description: The maximum number of labels to return per page. Note,
    - name: wiki-rest-api-content-id-notification-child-created
      path: /wiki/rest/api/content/{id}/notification/child-created
      operations:
      - name: getwatchesforpage
        method: GET
        description: Atlassian Get Watches for Page
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its watches.
          required: true
        - name: start
          in: query
          type: integer
          description: The starting index of the returned watches.
        - name: limit
          in: query
          type: integer
          description: The maximum number of watches to return per page.
    - name: wiki-rest-api-content-id-notification-created
      path: /wiki/rest/api/content/{id}/notification/created
      operations:
      - name: getwatchesforspace
        method: GET
        description: Atlassian Get Watches for Space
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its watches.
          required: true
        - name: start
          in: query
          type: integer
          description: The starting index of the returned watches.
        - name: limit
          in: query
          type: integer
          description: The maximum number of watches to return per page.
    - name: wiki-rest-api-content-id-property
      path: /wiki/rest/api/content/{id}/property
      operations:
      - name: getcontentproperties
        method: GET
        description: Atlassian Get Content Properties
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its properties.
          required: true
        - name: key
          in: query
          type: array
          description: The key of the content property.
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the content to
        - name: start
          in: query
          type: integer
          description: The starting index of the returned properties.
        - name: limit
          in: query
          type: integer
          description: The maximum number of properties to return per page.
    - name: wiki-rest-api-content-id-property-key
      path: /wiki/rest/api/content/{id}/property/{key}
      operations:
      - name: getcontentproperty
        method: GET
        description: Atlassian Get Content Property
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for the property.
          required: true
        - name: key
          in: path
          type: string
          description: The key of the content property.
          required: true
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the content to
        - name: status
          in: query
          type: array
          description: Filter the results to a set of content based on their status. If set to `any`,
    - name: wiki-rest-api-content-id-restriction
      path: /wiki/rest/api/content/{id}/restriction
      operations:
      - name: getrestrictions
        method: GET
        description: Atlassian Get Restrictions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its restrictions.
          required: true
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the content
        - name: start
          in: query
          type: integer
          description: The starting index of the users and groups in the returned restrictions.
        - name: limit
          in: query
          type: integer
          description: The maximum number of users and the maximum number of groups, in the
    - name: wiki-rest-api-content-id-restriction-byOperation
      path: /wiki/rest/api/content/{id}/restriction/byOperation
      operations:
      - name: getrestrictionsbyoperation
        method: GET
        description: Atlassian Get Restrictions by Operation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its restrictions.
          required: true
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the content
    - name: wiki-rest-api-content-id-restriction-byOperation-operationKey
      path: /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}
      operations:
      - name: getrestrictionsforoperation
        method: GET
        description: Atlassian Get Restrictions for Operation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its restrictions.
          required: true
        - name: operationKey
          in: path
          type: string
          description: The operation type of the restrictions to be returned.
          required: true
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the content
        - name: start
          in: query
          type: integer
          description: The starting index of the users and groups in the returned restrictions.
        - name: limit
          in: query
          type: integer
          description: The maximum number of users and the maximum number of groups, in the
    - name: wiki-rest-api-content-id-restriction-byOperation-operationKey-byGroupId-groupId
      path: /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/byGroupId/{groupId}
      operations:
      - name: getcontentrestrictionstatusforgroup
        method: GET
        description: Atlassian Get Content Restriction Status for Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content that the restriction applies to.
          required: true
        - name: operationKey
          in: path
          type: string
          description: The operation that the restriction applies to.
          required: true
        - name: groupId
          in: path
          type: string
          description: The id of the group to be queried for whether the content restriction
          required: true
    - name: wiki-rest-api-content-id-restriction-byOperation-operationKey-group-groupName
      path: /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}
      operations:
      - name: getcontentrestrictionstatusforgroup
        method: GET
        description: Atlassian Get Content Restriction Status for Group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content that the restriction applies to.
          required: true
        - name: operationKey
          in: path
          type: string
          description: The operation that the restriction applies to.
          required: true
        - name: groupName
          in: path
          type: string
          description: The name of the group to be queried for whether the content restriction
          required: true
    - name: wiki-rest-api-content-id-restriction-byOperation-operationKey-user
      path: /wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/user
      operations:
      - name: getcontentrestrictionstatusforuser
        method: GET
        description: Atlassian Get Content Restriction Status for User
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content that the restriction applies to.
          required: true
        - name: operationKey
          in: path
          type: string
          description: The operation that is restricted.
          required: true
    - name: wiki-rest-api-content-id-state
      path: /wiki/rest/api/content/{id}/state
      operations:
      - name: getcontentstate
        method: GET
        description: Atlassian Get Content State
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The id of the content whose content state is of interest.
          required: true
        - name: status
          in: query
          type: string
          description: Set status to one of [current,draft,archived]. Default value is current.
    - name: wiki-rest-api-content-id-version
      path: /wiki/rest/api/content/{id}/version
      operations:
      - name: getcontentversions
        method: GET
        description: Atlassian Get Content Versions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its versions.
          required: true
        - name: start
          in: query
          type: integer
          description: The starting index of the returned versions.
        - name: limit
          in: query
          type: integer
          description: The maximum number of versions to return per page.
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the content to expand. By default, the `content`
    - name: wiki-rest-api-content-id-version-versionNumber
      path: /wiki/rest/api/content/{id}/version/{versionNumber}
      operations:
      - name: getcontentversion
        method: GET
        description: Atlassian Get Content Version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The ID of the content to be queried for its version.
          required: true
        - name: versionNumber
          in: path
          type: integer
          description: The number of the version to be retrieved.
          required: true
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the content to expand. By default, the `content`
    authentication:
      type: bearer
      token: '{{env.ATLASSIAN_API_KEY}}'
  exposes:
  - type: rest
    namespace: confluence-content-get-rest
    port: 8080
    description: REST adapter for Atlassian Confluence Content API — Get. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/wiki/rest/api/content/{id}
      name: wiki-rest-api-content-id
      description: REST surface for wiki-rest-api-content-id.
      operations:
      - method: GET
        name: getcontentbyid
        description: Atlassian Get Content by Id
        call: confluence-content-get.getcontentbyid
        with:
          id: rest.id
          status: rest.status
          version: rest.version
          embeddedContentRender: rest.embeddedContentRender
          trigger: rest.trigger
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/content/{id}/child
      name: wiki-rest-api-content-id-child
      description: REST surface for wiki-rest-api-content-id-child.
      operations:
      - method: GET
        name: getcontentchildren
        description: Atlassian Get Content Children
        call: confluence-content-get.getcontentchildren
        with:
          id: rest.id
          expand: rest.expand
          parentVersion: rest.parentVersion
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/content/{id}/child/attachment
      name: wiki-rest-api-content-id-child-attachment
      description: REST surface for wiki-rest-api-content-id-child-attachment.
      operations:
      - method: GET
        name: getattachments
        description: Atlassian Get Attachments
        call: confluence-content-get.getattachments
        with:
          id: rest.id
          start: rest.start
          limit: rest.limit
          filename: rest.filename
          mediaType: rest.mediaType
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/content/{id}/child/attachment/{attachmentid}/download
      name: wiki-rest-api-content-id-child-attachment-attachmentid-download
      description: REST surface for wiki-rest-api-content-id-child-attachment-attachmentId-download.
      operations:
      - method: GET
        name: geturitodownloadattachment
        description: Atlassian Get Uri to Download Attachment
        call: confluence-content-get.geturitodownloadattachment
        with:
          id: rest.id
          attachmentId: rest.attachmentId
          version: rest.version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/content/{id}/child/comment
      name: wiki-rest-api-content-id-child-comment
      description: REST surface for wiki-rest-api-content-id-child-comment.
      operations:
      - method: GET
        name: getcontentcomments
        description: Atlassian Get Content Comments
        call: confluence-content-get.getcontentcomments
        with:
          id: rest.id
          parentVersion: rest.parentVersion
          start: rest.start
          limit: rest.limit
          location: rest.location
          depth: rest.depth
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/content/{id}/child/{type}
      name: wiki-rest-api-content-id-child-type
      description: REST surface for wiki-rest-api-content-id-child-type.
      operations:
      - method: GET
        name: getcontentchildrenbytype
        description: Atlassian Get Content Children by Type
        call: confluence-content-get.getcontentchildrenbytype
        with:
          id: rest.id
          type: rest.type
          parentVersion: rest.parentVersion
          start: rest.start
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/content/{id}/descendant
      name: wiki-rest-api-content-id-descendant
      description: REST surface for wiki-rest-api-content-id-descendant.
      operations:
      - method: GET
        name: getcontentdescendants
        description: Atlassian Get Content Descendants
        call: confluence-content-get.getcontentdescendants
        with:
          id: rest.id
          expand: rest.expand
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/content/{id}/history
      name: wiki-rest-api-content-id-history
      description: REST surface for wiki-rest-api-content-id-history.
      operations:
      - method: GET
        name: getcontenthistory
        description: Atlassian Get Content History
        call: confluence-content-get.getcontenthistory
        with:
          id: rest.id
          expand: rest.expand
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/content/{id}/history/{version}/macro/id/{macroid}
      name: wiki-rest-api-content-id-history-version-macro-id-macroid
      description: REST surface for wiki-rest-api-content-id-history-version-macro-id-macroId.
      operations:
      - method: GET
        name: getmacrobodybymacroid
        description: Atlassian Get Macro Body by Macro Id
        call: confluence-content-get.getmacrobodybymacroid
        with:
          id: rest.id
          version: rest.version
          macroId: rest.macroId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/content/{id}/history/{version}/macro/id/{macroid}/convert/async/{to}
      name: wiki-rest-api-content-id-history-version-macro-id-macroid-convert-async-to
      description: REST surface for wiki-rest-api-content-id-history-version-macro-id-macroId-convert-async-to.
      operations:
      - method: GET
        name: getmacrobodybymacroidandconvertrepresentationasynchronously
        description: Atlassian Get Macro Body by Macro Id and Convert Representation Asynchronously
        call: confluence-content-get.getmacrobodybymacroidandconvertrepresentationasynchronously
        with:
          id: rest.id
          version: rest.version
          macroId: rest.macroId
          to: rest.to
          allowCache: rest.allowCache
          spaceKeyContext: rest.spaceKeyContext
          embeddedContentRender: rest.embeddedContentRender
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/content/{id}/history/{version}/macro/id/{macroid}/convert/{to}
      name: wiki-rest-api-content-id-history-version-macro-id-macroid-convert-to
      description: REST surface for wiki-rest-api-content-id-history-version-macro-id-macroId-convert-to.
      operations:
      - method: GET
        na

# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/atlassian/refs/heads/main/capabilities/confluence-content-get.yaml