• 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

Label

Postman Collection
OpenAPI
GET

Return labels related to the given label name sorted by frequency of use in descending order, with a specified limit of results. The current process for identifying related labels solely examines global labels, but it may change in the future.

Example request URI's: https://example.com/confluence/rest/api/label/test_label_name/related https://example.com/confluence/rest/api/label/my:test_label_name/related?limit=200

labelName

string

Required
limit

string

Return a JSON representation of related labels to the given label name

application/json

Label
GET/rest/api/label/{labelName}/related
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/label/{labelName}/related' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 { "prefix": "my", "name": "label", "id": "1234", "label": "<string>" }
GET

Get recently used labels

Returns a paginated list of recently used labels within a Confluence instance. Labels are sorted from most to least recently used.

Example request URI's: https://example.com/confluence/rest/api/label/recent https://example.com/confluence/rest/api/label/recent?start=2&limit=1

Request

Query parameters

limit

string

start

string

Responses

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

application/json

object
GET/rest/api/label/recent
1 2 3 curl --request GET \ --url 'http://{baseurl}/confluence/rest/api/label/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" } }

Rate this page: