Cloud

Jira Cloud platform / Reference / REST API v2

Issue navigator settings

Postman Collection

OpenAPI

This resource represents issue navigator settings. Use it to get and set issue navigator default columns.

Operations

GET/rest/api/2/settings/columns PUT/rest/api/2/settings/columns

GET

Get issue navigator default columns

Returns the default issue navigator columns.

Permissions required: Administer Jira global permission.

Data Security Policy: Exempt from app access rules

Scopes

Forge and OAuth2 apps cannot access this REST resource.

Connect apps cannot access this REST resource.

Request

This request has no parameters.

Responses

Returned if the request is successful.

application/json

array<ColumnItem>

GET/rest/api/2/settings/columns

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://your-domain.atlassian.net/rest/api/2/settings/columns' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

200Response

[
  {
    "label": "Key",
    "value": "issuekey"
  },
  {
    "label": "Summary",
    "value": "summary"
  }
]

PUT

Set issue navigator default columns

Sets the default issue navigator columns.

The columns parameter accepts a navigable field value and is expressed as HTML form data. To specify multiple columns, pass multiple columns parameters. For example, in curl:

curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/2/settings/columns

If no column details are sent, then all default columns are removed.

A navigable field is one that can be used as a column on the issue navigator. Find details of navigable issue columns using Get fields.