ATatlassian
Label info

Get label information

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.

get/wiki/rest/api/label

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/wiki/rest/api/label
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:confluence-content.summary

Query parameters

namestring required

Name of the label to query.

type'page' | 'blogpost' | 'attachment' | 'page_template'

The type of contents that are to be returned.

startinteger

The starting offset for the results.

limitinteger

The number of results to be returned.

Response

Returned if the query fetches zero or more results.

Changes

No recorded changes to this operation across all 2 revisions of this API.