Sign in

v1

latestOpenAPI 3.0.12026-07-13130168404.3 KB
Experimental

Get Space Labels

Returns a list of labels associated with a space. Can provide a prefix as well as other filters to select different types of labels.

get/wiki/rest/api/space/{spaceKey}/label

Path parameters

spaceKeystring required

The key of the space to get labels for.

Query parameters

prefix'global' | 'my' | 'team'

Filters 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 labels that are on content within the provided space.
  • my prefix can be explicitly added by a user when adding a label via the UI, e.g. 'my:example-label'.
  • team prefix is used for labels applied to the space.
startinteger

The starting index of the returned labels.

limitinteger

The maximum number of labels to return per page. Note, this may be restricted by fixed system limits.

Response

Returned if the list of labels is returned.

startinteger
limitinteger
sizeinteger required
_linksGenericLinks