{ "opencollection": "1.0.0", "info": { "name": "Atlassian Admin Account Content - Children and Descendants API", "version": "1.0.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Content - Children and Descendants", "type": "folder" }, "items": [ { "info": { "name": "Atlassian Get Content Descendants by Type", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/descendant/:type", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to be queried for its descendants." }, { "name": "type", "value": "", "type": "path", "description": "The type of descendants to return." }, { "name": "depth", "value": "", "type": "query", "description": "Filter the results to descendants upto a desired level of the content. Note, the maximum value supported is 100. root level of the content means immediate (level 1) descendants of the type requested. all represents returning all descendants of the type requested." }, { "name": "expand", "value": "", "type": "query", "description": "A multi-value parameter indicating which properties of the content to expand.\n\n- `childTypes.all` returns whether the content has attachments, comments, or child pages/whiteboards.\nUse this if you only need to check whether the content has children of a particular type.\n- `childTypes.attachment` returns whether the content has attachments.\n- `childTypes.comment` returns whether the content has comments.\n- `childTypes.page` returns whether the content has child pages.\n- `container` returns the space that the content is in. This is the same as the information\nreturned by [Get space](#api-space-spaceKey-get).\n- `metadata.currentuser` returns information about the current user in relation to the content,\nincluding when they last viewed it, modified it, contributed to it, or added it as a favorite.\n- `metadata.properties` returns content properties that have been set via the Confluence REST API.\n- `metadata.labels` returns the labels that have been added to the content.\n- `metadata.frontend` this property is only used by Atlassian.\n- `operations` returns the operations for the content, which are used when setting permissions.\n- `children.page` returns pages that are descendants at the level immediately below the content.\n- `children.attachment` returns all attachments for the content.\n- `children.comment` returns all comments on the content.\n- `restrictions.read.restrictions.user` returns the users that have permission to read the content.\n- `restrictions.read.restrictions.group` returns the groups that have permission to read the content. Note that\nthis may return deleted groups, because deleting a group doesn't remove associated restrictions.\n- `restrictions.update.restrictions.user` returns the users that have permission to update the content.\n- `restrictions.update.restrictions.group` returns the groups that have permission to update the content. Note that\nthis may return deleted groups because deleting a group doesn't remove associated restrictions.\n- `history` returns the history of the content, including the date it was created.\n- `history.lastUpdated` returns information about the most recent update of the content, including\nwho updated it and when it was updated.\n- `history.previousVersion` returns information about the update prior to the current content update.\n- `history.contributors` returns all of the users who have contributed to the content.\n- `history.nextVersion` returns information about the update after to the current content update.\n- `ancestors` returns the parent content, if the content is a page or whiteboard.\n- `body` returns the body of the content in different formats, including the editor format,\nview format, and export format.\n- `body.storage` returns the body of content in storage format.\n- `body.view` returns the body of content in view format.\n- `version` returns information about the most recent update of the content, including who updated it\nand when it was updated.\n- `descendants.page` returns pages that are descendants at any level below the content.\n- `descendants.attachment` returns all attachments for the content, same as `children.attachment`.\n- `descendants.comment` returns all comments on the content, same as `children.comment`.\n- `space` returns the space that the content is in. This is the same as the information returned by\n[Get space](#api-space-spaceKey-get).\n\nIn addition, the following comment-specific expansions can be used:\n- `extensions.inlineProperties` returns inline comment-specific properties.\n- `extensions.resolution` returns the resolution status of each comment." }, { "name": "start", "value": "", "type": "query", "description": "The starting index of the returned content." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of content to return per page. Note,\nthis may be restricted by fixed system limits." } ] }, "docs": "This API operation retrieves descendant content of a specific type for a given Confluence content item identified by its ID. The endpoint allows you to fetch child content elements that exist below a parent page or blog post in the content hierarchy, filtered by a specific content type such as 'page', 'comment', or 'attachment'. It returns a paginated list of descendant content items matching the specified type, including metadata like title, ID, version information, and content status. This is " }, { "info": { "name": "Atlassian Get Content Children", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/child", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to be queried for its children." }, { "name": "expand", "value": "", "type": "query", "description": "A multi-value parameter indicating which properties of the children to expand, where:\n\n- `attachment` returns all attachments for the content.\n- `comments` returns all comments for the content.\n- `page` returns all child pages of the content.\n- Custom content types that are provided by apps are also supported." }, { "name": "parentVersion", "value": "", "type": "query", "description": "The version of the parent content to retrieve children for.\nCurrently, this only works for the latest version." } ] }, "docs": "Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).

Returns a map of the direct children of a piece of content. A piece of content
has different types of child content, depending on its type. These are
the default parent-child content type relationships:

- `page`: child content is `page`, `comment`, `attachment`
- `blogpost`: child content is `comment`, `attachment`
- `attachment`: child content is `comment`
- `comm" }, { "info": { "name": "Atlassian Move A Page To A New Location Relative To A Target Page", "type": "http" }, "http": { "method": "PUT", "url": "https://api.atlassian.com/wiki/rest/api/content/:pageId/move/:position/:targetId", "params": [ { "name": "pageId", "value": "", "type": "path", "description": "The ID of the page to be moved" }, { "name": "position", "value": "", "type": "path", "description": "The position to move the page to relative to the target page:\n* `before` - move the page under the same parent as the target, before the target in the list of children\n* `after` - move the page under the same parent as the target, after the target in the list of children\n* `append` - move the page to be a child of the target" }, { "name": "targetId", "value": "", "type": "path", "description": "The ID of the target page for this operation" } ] }, "docs": "Move a page to a new location relative to a target page:

* `before` - move the page under the same parent as the target, before the target in the list of children
* `after` - move the page under the same parent as the target, after the target in the list of children
* `append` - move the page to be a child of the target

Caution: This API can move pages to the top level of a space. Top-level pages are difficult to find in the UI
because they do not show up in the page tree " }, { "info": { "name": "Atlassian Get Content Children By Type", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/child/:type", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to be queried for its children." }, { "name": "type", "value": "", "type": "path", "description": "The type of children to return." }, { "name": "expand", "value": "", "type": "query", "description": "A multi-value parameter indicating which properties of the content to expand.\n\n- `childTypes.all` returns whether the content has attachments, comments, or child pages/whiteboards.\nUse this if you only need to check whether the content has children of a particular type.\n- `childTypes.attachment` returns whether the content has attachments.\n- `childTypes.comment` returns whether the content has comments.\n- `childTypes.page` returns whether the content has child pages.\n- `container` returns the space that the content is in. This is the same as the information\nreturned by [Get space](#api-space-spaceKey-get).\n- `metadata.currentuser` returns information about the current user in relation to the content,\nincluding when they last viewed it, modified it, contributed to it, or added it as a favorite.\n- `metadata.properties` returns content properties that have been set via the Confluence REST API.\n- `metadata.labels` returns the labels that have been added to the content.\n- `metadata.frontend` this property is only used by Atlassian.\n- `operations` returns the operations for the content, which are used when setting permissions.\n- `children.page` returns pages that are descendants at the level immediately below the content.\n- `children.attachment` returns all attachments for the content.\n- `children.comment` returns all comments on the content.\n- `restrictions.read.restrictions.user` returns the users that have permission to read the content.\n- `restrictions.read.restrictions.group` returns the groups that have permission to read the content. Note that\nthis may return deleted groups, because deleting a group doesn't remove associated restrictions.\n- `restrictions.update.restrictions.user` returns the users that have permission to update the content.\n- `restrictions.update.restrictions.group` returns the groups that have permission to update the content. Note that\nthis may return deleted groups because deleting a group doesn't remove associated restrictions.\n- `history` returns the history of the content, including the date it was created.\n- `history.lastUpdated` returns information about the most recent update of the content, including\nwho updated it and when it was updated.\n- `history.previousVersion` returns information about the update prior to the current content update.\n- `history.contributors` returns all of the users who have contributed to the content.\n- `history.nextVersion` returns information about the update after to the current content update.\n- `ancestors` returns the parent content, if the content is a page or whiteboard.\n- `body` returns the body of the content in different formats, including the editor format,\nview format, and export format.\n- `body.storage` returns the body of content in storage format.\n- `body.view` returns the body of content in view format.\n- `version` returns information about the most recent update of the content, including who updated it\nand when it was updated.\n- `descendants.page` returns pages that are descendants at any level below the content.\n- `descendants.attachment` returns all attachments for the content, same as `children.attachment`.\n- `descendants.comment` returns all comments on the content, same as `children.comment`.\n- `space` returns the space that the content is in. This is the same as the information returned by\n[Get space](#api-space-spaceKey-get).\n\nIn addition, the following comment-specific expansions can be used:\n- `extensions.inlineProperties` returns inline comment-specific properties.\n- `extensions.resolution` returns the resolution status of each comment." }, { "name": "parentVersion", "value": "", "type": "query", "description": "The version of the parent content to retrieve children for.\nCurrently, this only works for the latest version." }, { "name": "start", "value": "", "type": "query", "description": "The starting index of the returned content." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of content to return per page. Note,\nthis may be restricted by fixed system limits." } ] }, "docs": "Deprecated, use [Confluence's v2 API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).

Returns all children of a given type, for a piece of content.
A piece of content has different types of child content, depending on its type:

- `page`: child content is `page`, `comment`, `attachment`
- `blogpost`: child content is `comment`, `attachment`
- `attachment`: child content is `comment`
- `comment`: child content is `attachment`

Custom content types " }, { "info": { "name": "Atlassian Get Content Descendants", "type": "http" }, "http": { "method": "GET", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/descendant", "params": [ { "name": "id", "value": "", "type": "path", "description": "The ID of the content to be queried for its descendants." }, { "name": "expand", "value": "", "type": "query", "description": "A multi-value parameter indicating which properties of the children to\nexpand, where:\n\n- `attachment` returns all attachments for the content.\n- `comments` returns all comments for the content.\n- `page` returns all child pages of the content." } ] }, "docs": "Returns a map of the descendants of a piece of content. This is similar
to [Get content children](#api-content-id-child-get), except that this
method returns child pages at all levels, rather than just the direct
child pages.

A piece of content has different types of descendants, depending on its type:

- `page`: descendant is `page`, `comment`, `attachment`
- `blogpost`: descendant is `comment`, `attachment`
- `attachment`: descendant is `comment`
- `comment`: des" }, { "info": { "name": "Atlassian Copy Page Hierarchy", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/pagehierarchy/copy", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Copy page hierarchy allows the copying of an entire hierarchy of pages and their associated properties, permissions and attachments.
The id path parameter refers to the content id of the page to copy, and the new parent of this copied page is defined using the destinationPageId in the request body.
The titleOptions object defines the rules of renaming page titles during the copy;
for example, search and replace can be used in conjunction to rewrite the copied page titles.

Res" }, { "info": { "name": "Atlassian Copy Single Page", "type": "http" }, "http": { "method": "POST", "url": "https://api.atlassian.com/wiki/rest/api/content/:id/copy", "params": [ { "name": "id", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "A multi-value parameter indicating which properties of the content to expand.\nMaximum sub-expansions allowed is `8`.\n\n- `childTypes.all` returns whether the content has attachments, comments, or child pages/whiteboards.\nUse this if you only need to check whether the content has children of a particular type.\n- `childTypes.attachment` returns whether the content has attachments.\n- `childTypes.comment` returns whether the content has comments.\n- `childTypes.page` returns whether the content has child pages.\n- `container` returns the space that the content is in. This is the same as the information\nreturned by [Get space](#api-space-spaceKey-get).\n- `metadata.currentuser` returns information about the current user in relation to the content,\nincluding when they last viewed it, modified it, contributed to it, or added it as a favorite.\n- `metadata.properties` returns content properties that have been set via the Confluence REST API.\n- `metadata.labels` returns the labels that have been added to the content.\n- `metadata.frontend` this property is only used by Atlassian.\n- `operations` returns the operations for the content, which are used when setting permissions.\n- `children.page` returns pages that are descendants at the level immediately below the content.\n- `children.attachment` returns all attachments for the content.\n- `children.comment` returns all comments on the content.\n- `restrictions.read.restrictions.user` returns the users that have permission to read the content.\n- `restrictions.read.restrictions.group` returns the groups that have permission to read the content. Note that\nthis may return deleted groups, because deleting a group doesn't remove associated restrictions.\n- `restrictions.update.restrictions.user` returns the users that have permission to update the content.\n- `restrictions.update.restrictions.group` returns the groups that have permission to update the content. Note that\nthis may return deleted groups because deleting a group doesn't remove associated restrictions.\n- `history` returns the history of the content, including the date it was created.\n- `history.lastUpdated` returns information about the most recent update of the content, including\nwho updated it and when it was updated.\n- `history.previousVersion` returns information about the update prior to the current content update.\n- `history.contributors` returns all of the users who have contributed to the content.\n- `history.nextVersion` returns information about the update after to the current content update.\n- `ancestors` returns the parent content, if the content is a page or whiteboard.\n- `body` returns the body of the content in different formats, including the editor format,\nview format, and export format.\n- `body.storage` returns the body of content in storage format.\n- `body.view` returns the body of content in view format.\n- `version` returns information about the most recent update of the content, including who updated it\nand when it was updated.\n- `descendants.page` returns pages that are descendants at any level below the content.\n- `descendants.attachment` returns all attachments for the content, same as `children.attachment`.\n- `descendants.comment` returns all comments on the content, same as `children.comment`.\n- `space` returns the space that the content is in. This is the same as the information returned by\n[Get space](#api-space-spaceKey-get).\n\nIn addition, the following comment-specific expansions can be used:\n- `extensions.inlineProperties` returns inline comment-specific properties.\n- `extensions.resolution` returns the resolution status of each comment." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Copies a single page and its associated properties, permissions, attachments, and custom contents.
The `id` path parameter refers to the content ID of the page to copy. The target of the page to be copied
is defined using the `destination` in the request body and can be one of the following types.

- `space`: page will be copied to the specified space as a root page on the space
- `parent_page`: page will be copied as a child of the specified parent page
- `existing_pag" } ] } ], "bundled": true }