---
title: "Get fields"
method: GET
path: "/rest/api/3/field"
tags: ["Issue fields"]
---

# Get fields

`GET /rest/api/3/field`

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](https://confluence.atlassian.com/x/yodKLg) for.)

This operation can be accessed anonymously.

**[Permissions](#permissions) required:** None.

## Response `200`

Returned if the request is successful.

- FieldDetails[]
  - `clauseNames` string[] — The names that can be used to reference the field in an advanced search. For more information, see [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ).
  - `custom` boolean — Whether the field is a custom field.
  - `id` string — The ID of the field.
  - `key` string — The key of the field.
  - `name` string — The name of the field.
  - `navigable` boolean — Whether the field can be used as a column on the issue navigator.
  - `orderable` boolean — Whether the content of the field can be used to order lists.
  - `schema` JsonTypeBean — The schema of a field.
    - `configuration` object — If the field is a custom field, the configuration of the field.
    - `custom` string — If the field is a custom field, the URI of the field.
    - `customId` integer — If the field is a custom field, the custom ID of the field.
    - `items` string — When the data type is an array, the name of the field items within the array.
    - `system` string — If the field is a system field, the name of the field.
    - `type` string, required — The data type of the field.
  - `scope` Scope — The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).
    - `project` ProjectDetails — Details about a project.
      - `avatarUrls` AvatarUrlsBean
        - `16x16` string, uri — The URL of the item's 16x16 pixel avatar.
        - `24x24` string, uri — The URL of the item's 24x24 pixel avatar.
        - `32x32` string, uri — The URL of the item's 32x32 pixel avatar.
        - `48x48` string, uri — The URL of the item's 48x48 pixel avatar.
      - `id` string — The ID of the project.
      - `key` string — The key of the project.
      - `name` string — The name of the project.
      - `projectCategory` UpdatedProjectCategory — A project category.
        - `description` string — The name of the project category.
        - `id` string — The ID of the project category.
        - `name` string — The description of the project category.
        - `self` string — The URL of the project category.
      - `projectTypeKey` 'software' | 'service_desk' | 'business' — The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project.
      - `self` string — The URL of the project details.
      - `simplified` boolean — Whether or not the project is simplified.
    - `type` 'PROJECT' | 'TEMPLATE' — The type of scope.
  - `searchable` boolean — Whether the content of the field can be searched.

## Other responses

- `401` — Returned if the authentication credentials are incorrect or missing.

---

[API](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2.md) · [All operations](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api-2/versions/ec7f275dfee5/schema)