Rate this page:
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 app scope required: READ
read:confluence-content.summaryread:label:confluence, read:content:confluencestring
Name of the label to query.
string
The type of contents that are to be returned.
Valid values: page, blogpost, attachment, page_template
integer
The starting offset for the results.
0, Format: int32integer
The number of results to be returned.
200, Format: int321 2 3 4 5 6 7 8 9 10 11 12
// 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());Returned if the query fetches zero or more results.
| Content type | Value |
|---|---|
| application/json |
Rate this page: