• Attachment
  • Ancestors
  • Blog Post
  • Children
  • Classification Level
  • Comment
  • Content
  • Content Properties
  • Custom Content
  • Database
  • Data Policies
  • Label
  • Like
  • Operation
  • Page
  • Space
  • Space Permissions
  • Space Properties
  • Task
  • User
  • Version
  • Whiteboard
Cloud
Confluence Cloud / Reference / REST API v2

Children

Postman Collection
OpenAPI
GET

Get child pages

Returns all child pages for given page id. 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 access the Confluence site ('Can use' global permission). Only pages that the user has permission to view will be returned.

Data Security Policy: Not exempt from app access rules
Scopes

Connect app scope requiredREAD

read:page:confluence

Request

Path parameters

id

integer

Required

Query parameters

cursor

string

limit

integer

sort

string

Responses

Returned if the requested child pages are returned.

Headers

Link

string

application/json

MultiEntityResult<ChildPage>
GET/pages/{id}/children
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestConfluence(route`/wiki/api/v2/pages/{id}/children`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "results": [ { "id": "<string>", "status": "current", "title": "<string>", "spaceId": "<string>", "childPosition": 57 } ], "_links": { "next": "<string>", "base": "<string>" } }
GET

Get child custom content

Returns all child custom content for given custom content id. 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 access the Confluence site ('Can use' global permission). Only custom content that the user has permission to view will be returned.

Data Security Policy: Not exempt from app access rules
Scopes

Connect app scope requiredREAD

read:custom-content:confluence

Request

Path parameters

id

integer

Required

Query parameters

cursor

string

limit

integer

sort

string

Responses

Returned if the requested child custom content are returned.

Headers

Link

string

application/json

MultiEntityResult<ChildCustomContent>
GET/custom-content/{id}/children
1 2 3 4 5 6 7 8 9 10 11 12 // This sample uses Atlassian Forge // https://developer.atlassian.com/platform/forge/ import api, { route } from "@forge/api"; const response = await api.asUser().requestConfluence(route`/wiki/api/v2/custom-content/{id}/children`, { headers: { 'Accept': 'application/json' } }); console.log(`Response: ${response.status} ${response.statusText}`); console.log(await response.json());
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "results": [ { "id": "<string>", "status": "current", "title": "<string>", "type": "<string>", "spaceId": "<string>" } ], "_links": { "next": "<string>", "base": "<string>" } }

Rate this page: