ATatlassian
Label

Get labels for space

Returns the labels of specific space. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

Permissions required: Permission to view the space. Only labels that the user has permission to view will be returned.

get/spaces/{id}/labels

Request

  • Base URL
    https://no-default/wiki/api/v2
  • URL
    https://no-default/wiki/api/v2/spaces/{id}/labels
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: read:space:confluence

Path parameters

idinteger required

The ID of the space for which labels should be returned.

Query parameters

prefix'my' | 'team'

Filter the results to labels based on their prefix.

sortstring

Used to sort the result by a particular field.

cursorstring

Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

limitinteger

Maximum number of labels per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

Response

Returned if the requested labels are returned.

Changes

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