Labels

Get all labels

Changed on

Returns a paginated list of labels.

get/rest/api/2/label

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/label
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: read:jira-work)

Query parameters

startAtinteger

The index of the first item to return in a page of results (page offset).

maxResultsinteger

The maximum number of items to return per page.

querystring

Case-insensitive prefix used to filter labels before pagination.

scopestring

RECENT_PROJECTS or ALL_BROWSEABLE_PROJECTS. Omitted scope retains the unbounded search. Blank or unrecognised values use ALL_BROWSEABLE_PROJECTS.

Response

Returned if the request is successful.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

If there is another page of results, the URL of the next page.

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.

valuesstring[]

The list of items.

Changes

  • f3cabb30c5d7Revision changes
    • info

      added the new optional query request parameter query

    • info

      added the new optional query request parameter scope