Rate this page:

Label info

Get Label information.

GET /wiki/rest/api/label

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.

Apps cannot access this REST resource.

OAuth scopes required
read:confluence-content.summary

Request

Query parameters
name Required

string

Name of the label to query.

type

string

The type of contents that are to be returned.

Valid values: page, blogpost, attachment, page_template

start

integer

The starting offset for the results.

Default: 0, Format: int32
limit

integer

The number of results to be returned.

Default: 200, Format: int32

Example

1
2
3
curl --request GET \
  --url 'https://your-domain.atlassian.net/wiki/rest/api/label?name={name}' \
  --header 'Accept: application/json'

Responses

Returned if the query fetches zero or more results.

Content typeValue
application/json

LabelDetails

Rate this page: