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

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

Servers

Path parameters

Name Type Required Description
spaceKey String Yes

The key of the space to get labels for.

Query parameters

Name Type Required Description
prefix String No

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.

Possible values:

  • "global"
  • "my"
  • "team"
limit Integer No

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

Default value: 200

start Integer No

The starting index of the returned labels.

Default value: 0

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.