Get Fields Paginated

GET {{baseUrl}}/rest/api/3/field/search?startAt=0&maxResults=50&type=<string>&type=<string>&id=<string>&query=<string>&orderBy=<string>&expand=<string>

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.

Request Params

Key	Datatype	Description
`startAt`	number	The index of the first item to return in a page of results (page offset).
`maxResults`	number	The maximum number of items to return per page.
`type`	string	The type of fields to search.
`type`	string	The type of fields to search.
`id`	string	The IDs of the custom fields to return or, where `query` is specified, filter.
`query`	string	String used to perform a case-insensitive partial match with field names or descriptions.
`orderBy`	string	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 | | 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. |

RESPONSES

status: OK

{&quot;maxResults&quot;:50,&quot;startAt&quot;:0,&quot;total&quot;:2,&quot;isLast&quot;:false,&quot;values&quot;:[{&quot;id&quot;:&quot;customfield_10000&quot;,&quot;name&quot;:&quot;Approvers&quot;,&quot;description&quot;:&quot;Contains users needed for approval. This custom field was created by Jira Service Desk.&quot;,&quot;key&quot;:&quot;customfield_10000&quot;,&quot;isLocked&quot;:true,&quot;screensCount&quot;:2,&quot;contextsCount&quot;:2,&quot;lastUsed&quot;:{&quot;type&quot;:&quot;TRACKED&quot;,&quot;value&quot;:&quot;2019-09-12T10:10:00.055+0000&quot;}},{&quot;id&quot;:&quot;customfield_10001&quot;,&quot;name&quot;:&quot;Change reason&quot;,&quot;description&quot;:&quot;Choose the reason for the change request&quot;,&quot;key&quot;:&quot;customfield_10001&quot;,&quot;isLocked&quot;:false,&quot;screensCount&quot;:2,&quot;contextsCount&quot;:2}]}