Labels

Postman Collection

OpenAPI

This resource represents available labels. Use it to get available labels for the global label field.

Operations

GET/rest/api/3/label

GET

Get all labels

Returns a paginated list of labels.

Data Security Policy: Exempt from app access rules

Scopes

OAuth 2.0 scopes required:

ClassicRECOMMENDED:read:jira-work

Granular:read:label:jira

Connect app scope required: READ

Request

Query parameters

startAt

integer

maxResults

integer

Responses

Returned if the request is successful.

application/json

PageBeanString

A page of items.

GET/rest/api/3/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().requestJira(route`/rest/api/3/label`, {
  headers: {
    'Accept': 'application/json'
  }
});

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

200Response

{
  "isLast": false,
  "maxResults": 2,
  "startAt": 0,
  "total": 100,
  "values": [
    "performance",
    "security"
  ]
}