GET

Get direct children of a whiteboard

Returns all children for given whiteboard id in the content tree. 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.

The following types of content will be returned:

  • Database
  • Embed
  • Folder
  • Page
  • Whiteboard

This endpoint returns minimal information about each child. To fetch more details, use a related endpoint based on the content type, such as:

Permissions required: Permission to access the Confluence site ('Can use' global permission). Only content that the user has permission to view will be returned.

Data Security Policy: Not exempt from app access rules
Scopes
read:hierarchical-content:confluence

Connect app scope requiredREAD

Request

Path parameters

id

integer

Required

Query parameters

cursor

string

limit

integer

sort

string

Responses

Returned if the requested children are returned.

Headers

Link

string

application/json

MultiEntityResult<ChildrenResponse>
GET/whiteboards/{id}/direct-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/whiteboards/{id}/direct-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 16 { "results": [ { "id": "<string>", "status": "current", "title": "<string>", "type": "<string>", "spaceId": "<string>", "childPosition": 55 } ], "_links": { "next": "<string>", "base": "<string>" } }
GET

Get direct children of a database

Returns all children for given database id in the content tree. 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.

The following types of content will be returned:

  • Database
  • Embed
  • Folder
  • Page
  • Whiteboard

This endpoint returns minimal information about each child. To fetch more details, use a related endpoint based on the content type, such as:

Permissions required: Permission to access the Confluence site ('Can use' global permission). Only content that the user has permission to view will be returned.

Data Security Policy: Not exempt from app access rules
Scopes
read:hierarchical-content:confluence

Connect app scope requiredREAD

Request

Path parameters

id

integer

Required

Query parameters

cursor

string

limit

integer

sort

string

Responses

Returned if the requested children are returned.

Headers

Link

string

application/json

MultiEntityResult<ChildrenResponse>
GET/databases/{id}/direct-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/databases/{id}/direct-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 16 { "results": [ { "id": "<string>", "status": "current", "title": "<string>", "type": "<string>", "spaceId": "<string>", "childPosition": 55 } ], "_links": { "next": "<string>", "base": "<string>" } }
GET

Get direct children of a Smart Link

Returns all children for given smart link id in the content tree. 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.

The following types of content will be returned:

  • Database
  • Embed
  • Folder
  • Page
  • Whiteboard

This endpoint returns minimal information about each child. To fetch more details, use a related endpoint based on the content type, such as:

Permissions required: Permission to access the Confluence site ('Can use' global permission). Only content that the user has permission to view will be returned.

Data Security Policy: Not exempt from app access rules
Scopes
read:hierarchical-content:confluence

Connect app scope requiredREAD

Request

Path parameters

id

integer

Required

Query parameters

cursor

string

limit

integer

sort

string

Responses

Returned if the requested children are returned.

Headers

Link

string

application/json

MultiEntityResult<ChildrenResponse>
GET/embeds/{id}/direct-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/embeds/{id}/direct-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 16 { "results": [ { "id": "<string>", "status": "current", "title": "<string>", "type": "<string>", "spaceId": "<string>", "childPosition": 55 } ], "_links": { "next": "<string>", "base": "<string>" } }
GET

Get direct children of a folder

Returns all children for given folder id in the content tree. 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.

The following types of content will be returned:

  • Database
  • Embed
  • Folder
  • Page
  • Whiteboard

This endpoint returns minimal information about each child. To fetch more details, use a related endpoint based on the content type, such as:

Permissions required: Permission to access the Confluence site ('Can use' global permission). Only content that the user has permission to view will be returned.

Data Security Policy: Not exempt from app access rules
Scopes
read:hierarchical-content:confluence

Connect app scope requiredREAD

Request

Path parameters

id

integer

Required

Query parameters

cursor

string

limit

integer

sort

string

Responses

Returned if the requested children are returned.

Headers

Link

string

application/json

MultiEntityResult<ChildrenResponse>
GET/folders/{id}/direct-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/folders/{id}/direct-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 16 { "results": [ { "id": "<string>", "status": "current", "title": "<string>", "type": "<string>", "spaceId": "<string>", "childPosition": 55 } ], "_links": { "next": "<string>", "base": "<string>" } }
GET

Get child pagesDeprecated

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
read:page:confluence

Connect app scope requiredREAD

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
read:custom-content:confluence

Connect app scope requiredREAD

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>" } }
GET

Get direct children of a page

Returns all children for given page id in the content tree. 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.

The following types of content will be returned:

  • Database
  • Embed
  • Folder
  • Page
  • Whiteboard

This endpoint returns minimal information about each child. To fetch more details, use a related endpoint based on the content type, such as:

Permissions required: Permission to access the Confluence site ('Can use' global permission). Only content that the user has permission to view will be returned.

Data Security Policy: Not exempt from app access rules
Scopes
read:hierarchical-content:confluence

Connect app scope requiredREAD

Request

Path parameters

id

integer

Required

Query parameters

cursor

string

limit

integer

sort

string

Responses

Returned if the requested children are returned.

Headers

Link

string

application/json

MultiEntityResult<ChildrenResponse>
GET/pages/{id}/direct-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}/direct-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 16 { "results": [ { "id": "<string>", "status": "current", "title": "<string>", "type": "<string>", "spaceId": "<string>", "childPosition": 55 } ], "_links": { "next": "<string>", "base": "<string>" } }

Rate this page: