The Confluence Cloud REST API

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.

Connect 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

Forge

cURL

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/label?name={name}`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

Responses

200

400

403

404

Returned if the query fetches zero or more results.

Content type	Value
application/json	LabelDetails