Get fields paginated

Returns a paginated list of fields for Classic Jira projects. The list can include:

all fields

specific fields, by defining id

fields that contain a string in the field name or description, by defining query

specific fields that contain a string in the field name or description, by defining id and query

Only custom fields can be queried, type must be set to custom.

Permissions required: Administer Jira global permission.

{"maxResults":50,"startAt":0,"total":2,"isLast":false,"values":[{"id":"customfield_10000","name":"Approvers","schema":{"type":"array","items":"user","custom":"com.atlassian.jira.plugin.system.customfieldtypes:multiuserpicker","customId":10000},"description":"Contains users needed for approval. This custom field was created by Jira Service Desk.","key":"customfield_10000","isLocked":true,"searcherKey":"com.atlassian.jira.plugin.system.customfieldtypes:userpickergroupsearcher","screensCount":2,"contextsCount":2,"lastUsed":{"type":"TRACKED","value":"2019-09-12T10:10:00.904+0000"}},{"id":"customfield_10001","name":"Change reason","schema":{"type":"option","custom":"com.atlassian.jira.plugin.system.customfieldtypes:select","customId":10001},"description":"Choose the reason for the change request","key":"customfield_10001","isLocked":false,"searcherKey":"com.atlassian.jira.plugin.system.customfieldtypes:multiselectsearcher","screensCount":2,"contextsCount":2,"projectsCount":2,"lastUsed":{"type":"NOT_TRACKED"}}]}

Request

Query Params

startAt

integer

optional

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

maxResults

integer

optional

The maximum number of items to return per page.

type

array[string]

optional

The type of fields to search.

array[string]

optional

The IDs of the custom fields to return or, where query is specified, filter.

query

string

optional

String used to perform a case-insensitive partial match with field names or descriptions.

orderBy

string

optional

Order the results by a field:

contextsCount sorts by the number of contexts related to a field

lastUsed sorts by the date when the value of the field last changed

name sorts by the field name

screensCount sorts by the number of screens related to a field

expand

string

optional

Use expand to include additional information in the response. This parameter accepts a comma-separated list. Expand options include:

key returns the key for each field

lastUsed returns the date when the value of the field last changed

screensCount returns the number of screens related to a field

contextsCount returns the number of contexts related to a field

isLocked returns information about whether the field is locked

searcherKey returns the searcher key for each custom field

Responses

🟢200Returned if the request is successful.

application/json

Body

A page of items.

isLast

boolean

read-onlyoptional

Whether this is the last page.

maxResults

integer <int32>

read-onlyoptional

The maximum number of items that could be returned.

string <uri>

read-onlyoptional

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

self

string <uri>

read-onlyoptional

The URL of the page.

startAt

integer <int64>

read-onlyoptional

The index of the first item returned.

total

integer <int64>

read-onlyoptional

The number of items returned.

values

array[object (Field) {12}]

read-onlyoptional

The list of items.

contextsCount

integer <int64>

optional

Number of contexts where the field is used.

description

string

optional

The description of the field.

string

required

The ID of the field.

isLocked

boolean

optional

Whether the field is locked.

isUnscreenable

boolean

optional

Whether the field is shown on screen or not.

key

string

optional

The key of the field.

lastUsed

object (FieldLastUsed)

optional

Information about the most recent use of a field.

name

string

required

The name of the field.

projectsCount

integer <int64>

optional

Number of projects where the field is used.

schema

object (JsonTypeBean)

required

The schema of a field.

screensCount

integer <int64>

optional

Number of screens where the field is used.

searcherKey

string

optional

The searcher key of the field. Returned for custom fields.

🟠400Returned if the request is invalid.

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

🟠403Returned if the user does not have the necessary permission.