Get fields

Returns system and custom issue fields according to the following rules:

Fields that cannot be added to the issue navigator are always returned.

Fields that cannot be placed on an issue screen are always returned.

Fields that depend on global Jira settings are only returned if the setting is enabled. That is, timetracking fields, subtasks, votes, and watches.

For all other fields, this operation only returns the fields that the user has permission to view (that is, the field is used in at least one project that the user has Browse Projects project permission for.)

This operation can be accessed anonymously.

Permissions required: None.

[{"id":"description","name":"Description","custom":false,"orderable":true,"navigable":true,"searchable":true,"clauseNames":["description"],"schema":{"type":"string","system":"description"}},{"id":"summary","key":"summary","name":"Summary","custom":false,"orderable":true,"navigable":true,"searchable":true,"clauseNames":["summary"],"schema":{"type":"string","system":"summary"}}]

Responses

🟢200Returned if the request is successful.

application/json

Body

array of:

clauseNames

array[string]

optional

The names that can be used to reference the field in an advanced search. For more information, see Advanced searching - fields reference.

custom

boolean

optional

Whether the field is a custom field.

string

optional

The ID of the field.

key

string

optional

The key of the field.

name

string

optional

The name of the field.

navigable

boolean

optional

Whether the field can be used as a column on the issue navigator.

orderable

boolean

optional

Whether the content of the field can be used to order lists.

schema

object

optional

The data schema for the field.

configuration

object

read-onlyoptional

If the field is a custom field, the configuration of the field.

custom

string

read-onlyoptional

If the field is a custom field, the URI of the field.

customId

integer <int64>

read-onlyoptional

If the field is a custom field, the custom ID of the field.

items

string

read-onlyoptional

When the data type is an array, the name of the field items within the array.

system

string

read-onlyoptional

If the field is a system field, the name of the field.

type

string

read-onlyrequired

The data type of the field.

scope

object

optional

The scope of the field.

project

object

read-onlyoptional

The project the item has scope in.

type

enum<string>

read-onlyoptional

The type of scope.

Allowed values:

PROJECTTEMPLATE

Additional properties

integer | number | string | boolean

optional

searchable

boolean

optional

Whether the content of the field can be searched.

🟠401Returned if the authentication credentials are incorrect or missing.

Request

Responses