Get Label information.

GET {{baseUrl}}/api/label?name=&type=&start=0&limit=200

Returns label information and a list of contents associated with the label.

Permissions required: Permission to access the Confluence site ('Can use' global permission). Only contents that the user is permitted to view is returned.

Request Params

KeyDatatypeRequiredDescription
namenull(Required) Name of the label to query.
typenullThe type of contents that are to be returned.
startnumberThe starting offset for the results.
limitnumberThe number of results to be returned.

RESPONSES

status: OK

{"label":{"prefix":"est dolore","name":"elit magna culpa voluptate minim","id":"fugiat in occaecat","label":"Excepteur eu culpa qui non"},"associatedContents":{"results":[{"contentType":"attachment","contentId":-15123374,"title":"est"},{"contentType":"attachment","contentId":29751066,"title":"in fugiat"}],"size":-57367807,"start":711472,"limit":-23936898}}