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:
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.
read:hierarchical-content:confluence
Connect app scope required: READ
integer
Requiredstring
integer
string
Returned if the requested children are returned.
string
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());
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>"
}
}
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:
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.
read:hierarchical-content:confluence
Connect app scope required: READ
integer
Requiredstring
integer
string
Returned if the requested children are returned.
string
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());
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>"
}
}
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:
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.
read:hierarchical-content:confluence
Connect app scope required: READ
integer
Requiredstring
integer
string
Returned if the requested children are returned.
string
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());
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>"
}
}
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:
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.
read:hierarchical-content:confluence
Connect app scope required: READ
integer
Requiredstring
integer
string
Returned if the requested children are returned.
string
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());
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>"
}
}
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.
read:page:confluence
Connect app scope required: READ
integer
Requiredstring
integer
string
Returned if the requested child pages are returned.
string
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());
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>"
}
}
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.
read:custom-content:confluence
Connect app scope required: READ
integer
Requiredstring
integer
string
Returned if the requested child custom content are returned.
string
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());
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>"
}
}
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:
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.
read:hierarchical-content:confluence
Connect app scope required: READ
integer
Requiredstring
integer
string
Returned if the requested children are returned.
string
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());
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: