• Access Mode
  • Admin Group
  • Admin User
  • Attachments
  • Backup and Restore
  • Category
  • Child Content
  • Content Blueprint
  • Content Body
  • Content Descendant
  • Content Labels
  • Content Property
  • Content Resource
  • Content Restrictions
  • Content Version
  • Content Watchers
  • GlobalColorScheme
  • Group
  • Instance Metrics
  • Label
  • Long Task
  • Server Information
  • Space
  • Space Label
  • Space Permissions
  • Space Property
  • Space Watchers
  • SpaceColorScheme
  • User
  • User Group
  • User Watch
  • Webhooks
  • Other operations
Server
Confluence Data Center / / REST API

Space Label

Postman Collection
OpenAPI
GET

Fetch all labels

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

Request

Path parameters

spaceKey

string

Required

Query parameters

limit

string

start

string

Responses

a JSON representation of the lists label, or an empty list if no labels are found.

application/json

object
GET/rest/api/space/{spaceKey}/labels
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/labels' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 { "results": [ { "prefix": "my", "name": "label", "id": "1234", "label": "<string>" } ], "start": 25, "limit": 25, "size": 25, "_links": { "base": "http://localhost:8085/rest/api", "self": "http://localhost:8085/rest/api", "context": "http://localhost:8085/rest/api", "next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50", "prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0" } }
GET

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

spaceKey

string

Required
limit

string

start

string

returns a JSON representation of the lists label, or an empty list if no labels are found.

application/json

object
GET/rest/api/space/{spaceKey}/labels/popular
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/labels/popular' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 { "results": [ { "prefix": "my", "name": "label", "id": "1234", "label": "<string>" } ], "start": 25, "limit": 25, "size": 25, "_links": { "base": "http://localhost:8085/rest/api", "self": "http://localhost:8085/rest/api", "context": "http://localhost:8085/rest/api", "next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50", "prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0" } }
GET

Get recent labels

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

Request

Path parameters

spaceKey

string

Required

Query parameters

limit

string

start

string

Responses

returns a full JSON representation of a piece of content.

application/json

object
GET/rest/api/space/{spaceKey}/labels/recent
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/labels/recent' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 { "results": [ { "prefix": "my", "name": "label", "id": "1234", "label": "<string>" } ], "start": 25, "limit": 25, "size": 25, "_links": { "base": "http://localhost:8085/rest/api", "self": "http://localhost:8085/rest/api", "context": "http://localhost:8085/rest/api", "next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50", "prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0" } }
GET

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

spaceKey

string

Required
labelName

string

Required
limit

string

start

string

a JSON representation of the lists label, or an empty list if no labels are found.

application/json

object
GET/rest/api/space/{spaceKey}/labels/{labelName}/related
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/space/{spaceKey}/labels/{labelName}/related' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 { "results": [ { "prefix": "my", "name": "label", "id": "1234", "label": "<string>" } ], "start": 25, "limit": 25, "size": 25, "_links": { "base": "http://localhost:8085/rest/api", "self": "http://localhost:8085/rest/api", "context": "http://localhost:8085/rest/api", "next": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=50", "prev": "http://localhost:8085/rest/api/latest/../paginate?limit=25&start=0" } }

Rate this page: