Returns the labels of specific attachment. 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 view the parent content of the attachment and its corresponding space. Only labels that the user has permission to view will be returned.
read:attachment:confluenceConnect app scope required: READ
integer
Requiredstring
string
string
integer
Returned if the requested labels 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/attachments/{id}/labels`, {
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
{
"results": [
{
"id": "<string>",
"name": "<string>",
"prefix": "<string>"
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns the labels of specific blog post. 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 view the content of the blog post and its corresponding space. Only labels that the user has permission to view will be returned.
read:page:confluenceConnect app scope required: READ
integer
Requiredstring
string
string
integer
Returned if the requested labels 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/blogposts/{id}/labels`, {
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
{
"results": [
{
"id": "<string>",
"name": "<string>",
"prefix": "<string>"
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns the labels for a specific piece of custom content. 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 view the custom content and its corresponding space. Only labels that the user has permission to view will be returned.
read:custom-content:confluenceConnect app scope required: READ
integer
Requiredstring
string
string
integer
Returned if the requested labels 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}/labels`, {
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
{
"results": [
{
"id": "<string>",
"name": "<string>",
"prefix": "<string>"
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns all labels. 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 labels that the user has permission to view will be returned.
read:label:confluenceConnect app scope required: READ
array<integer>
array<string>
string
string
integer
Returned if the requested labels 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/labels`, {
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
{
"results": [
{
"id": "<string>",
"name": "<string>",
"prefix": "<string>"
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns the labels of specific page. 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 view the content of the page and its corresponding space. Only labels that the user has permission to view will be returned.
read:page:confluenceConnect app scope required: READ
integer
Requiredstring
string
string
integer
Returned if the requested labels 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}/labels`, {
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
{
"results": [
{
"id": "<string>",
"name": "<string>",
"prefix": "<string>"
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns the labels of specific space. 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 view the space. Only labels that the user has permission to view will be returned.
read:space:confluenceConnect app scope required: READ
integer
Requiredstring
string
string
integer
Returned if the requested labels 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/spaces/{id}/labels`, {
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
{
"results": [
{
"id": "<string>",
"name": "<string>",
"prefix": "<string>"
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Returns the labels of space content (pages, blogposts etc). 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 view the space. Only labels that the user has permission to view will be returned.
read:space:confluenceConnect app scope required: READ
integer
Requiredstring
string
string
integer
Returned if the requested labels 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/spaces/{id}/content/labels`, {
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
{
"results": [
{
"id": "<string>",
"name": "<string>",
"prefix": "<string>"
}
],
"_links": {
"next": "<string>",
"base": "<string>"
}
}Rate this page: