Get labels for content

GET {{baseUrl}}/api/content/:id/label?prefix=<string>&start=0&limit=200

Returns the labels on a piece of content.

Permissions required: 'View' permission for the space and permission to view the content if it is a page.

Request Params

KeyDatatypeRequiredDescription
prefixstringFilters the results to labels with the specified prefix. If this parameter
is not specified, then labels with any prefix will be returned.
  • global prefix is used by default when a user adds a label via the UI.
  • my prefix can be explicitly added by a user when adding a label via the UI, e.g. 'my:example-label'. Also, when a page is selected as a favourite, the 'my:favourite' label is automatically added.
  • team can used when adding labels via Add labels to content but is not used in the UI. | | start | number | | The starting index of the returned labels. | | limit | number | | The maximum number of labels to return per page. Note, this may be restricted by fixed system limits. |

RESPONSES

status: OK

{&quot;results&quot;:[{&quot;prefix&quot;:&quot;Duis elit dolor officia&quot;,&quot;name&quot;:&quot;non sunt&quot;,&quot;id&quot;:&quot;nulla veniam&quot;,&quot;label&quot;:&quot;deserunt Ut Excepteur magna&quot;},{&quot;prefix&quot;:&quot;in consequat deserun&quot;,&quot;name&quot;:&quot;officia cillum enim&quot;,&quot;id&quot;:&quot;Lorem quis esse amet&quot;,&quot;label&quot;:&quot;dolore esse&quot;}],&quot;start&quot;:-32316568,&quot;limit&quot;:-3993073,&quot;size&quot;:-78086889,&quot;_links&quot;:{}}