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.

Servers

Query parameters

Name Type Required Description
name String Yes

Name of the label to query.

limit Integer No

The number of results to be returned.

Default value: 200

type String No

The type of contents that are to be returned.

Possible values:

  • "attachment"
  • "blogpost"
  • "page"
  • "page_template"
start Integer No

The starting offset for the results.

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.