Label info

Postman Collection

OpenAPI

Operations

GET/wiki/rest/api/label

GET

Get label information

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.

Data Security Policy: Not exempt from app access rules

Scopes

OAuth 2.0 scopes required:

ClassicRECOMMENDED:read:confluence-content.summary

Granular:read:label:confluence, read:content:confluence

Connect app scope required: READ

Request

Query parameters

name

string

Required

type

string

start

integer

limit

integer

Responses

Returned if the query fetches zero or more results.

application/json

LabelDetails

GET/wiki/rest/api/label

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.asUser().requestConfluence(route`/wiki/rest/api/label?name={name}`, {
  headers: {
    'Accept': 'application/json'
  }
});

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

200Response

{
  "label": {
    "prefix": "<string>",
    "name": "<string>",
    "id": "<string>",
    "label": "<string>"
  },
  "associatedContents": {
    "results": [
      {
        "contentType": "page",
        "contentId": 2154,
        "title": "<string>"
      }
    ],
    "start": 2154,
    "limit": 2154,
    "size": 2154
  }
}