Returns a paginated list of all Labels used by Content within the given Space. This includes Labels used by Pages, Blog Posts, and other Content types.
Example request URI:
https://example.com/confluence/rest/api/space/TEST/labels
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
string
a JSON representation of the lists label, or an empty list if no labels are found.
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/labels' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
"results": [
{
"prefix": "my",
"name": "label",
"id": "1234",
"label": "<string>",
"_links": {
"base": "<string>",
"context": "<string>",
"self": "<string>"
},
"_expandable": {
"attribute": "<string>"
}
}
],
"totalCount": 2154,
"start": 25,
"limit": 25,
"size": 25,
"_links": {
"base": "http://localhost:8085/confluence",
"context": "confluence",
"self": "http://localhost:8085/rest/api/latest/..?limit=25&start=25",
"next": "http://localhost:8085/rest/api/latest/..?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/..?limit=25&start=0"
}
}Returns a paginated list of all Labels used by Content within the given Space.This includes Labels used by Pages, Blog Posts, and other Content types.
Example request URI(s):
https://example.com/confluence/rest/api/space/TEST/labels/popular
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
string
returns a JSON representation of the lists label, or an empty list if no labels are found.
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/labels/popular' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
"results": [
{
"prefix": "my",
"name": "label",
"id": "1234",
"label": "<string>",
"_links": {
"base": "<string>",
"context": "<string>",
"self": "<string>"
},
"_expandable": {
"attribute": "<string>"
}
}
],
"totalCount": 2154,
"start": 25,
"limit": 25,
"size": 25,
"_links": {
"base": "http://localhost:8085/confluence",
"context": "confluence",
"self": "http://localhost:8085/rest/api/latest/..?limit=25&start=25",
"next": "http://localhost:8085/rest/api/latest/..?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/..?limit=25&start=0"
}
}Returns a paginated list of the most recent Labels used by Content within the given Space.This includes Labels used by Pages, Blog Posts, and other Content types.
Example request URI:
https://example.com/confluence/rest/api/space/TEST/labels/recent
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
string
returns a full JSON representation of a piece of content.
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/labels/recent' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
"results": [
{
"prefix": "my",
"name": "label",
"id": "1234",
"label": "<string>",
"_links": {
"base": "<string>",
"context": "<string>",
"self": "<string>"
},
"_expandable": {
"attribute": "<string>"
}
}
],
"totalCount": 2154,
"start": 25,
"limit": 25,
"size": 25,
"_links": {
"base": "http://localhost:8085/confluence",
"context": "confluence",
"self": "http://localhost:8085/rest/api/latest/..?limit=25&start=25",
"next": "http://localhost:8085/rest/api/latest/..?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/..?limit=25&start=0"
}
}Returns a paginated list of related Labels used by Content within the given Space.A Label is defined as being related to another when it is found attached to the same Content as the Label specified in the request.
Example request URI:
https://example.com/confluence/rest/api/space/TEST/labels/example-label/related
Forge and OAuth2 apps cannot access this REST resource.
string
Requiredstring
Requiredstring
string
a JSON representation of the lists label, or an empty list if no labels are found.
1
2
3
curl --request GET \
--url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/labels/{labelName}/related' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
"results": [
{
"prefix": "my",
"name": "label",
"id": "1234",
"label": "<string>",
"_links": {
"base": "<string>",
"context": "<string>",
"self": "<string>"
},
"_expandable": {
"attribute": "<string>"
}
}
],
"totalCount": 2154,
"start": 25,
"limit": 25,
"size": 25,
"_links": {
"base": "http://localhost:8085/confluence",
"context": "confluence",
"self": "http://localhost:8085/rest/api/latest/..?limit=25&start=25",
"next": "http://localhost:8085/rest/api/latest/..?limit=25&start=50",
"prev": "http://localhost:8085/rest/api/latest/..?limit=25&start=0"
}
}Rate this page: