v4

latestOpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Issue fields

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.
  • Fields that are not associated to any used field configurations or screens are not returned.
  • 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.

get/rest/api/3/field

Response

Returned if the request is successful.

clauseNamesstring[]

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

customboolean

Whether the field is a custom field.

idstring

The ID of the field.

keystring

The key of the field.

namestring

The name of the field.

navigableboolean

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

orderableboolean

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

searchableboolean

Whether the content of the field can be searched.