GET /rest/api/2/field/search

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

Use type must be set to custom to show custom fields only.

Permissions required: Administer Jira global permission.

Servers

https://your-domain.atlassian.net

Query parameters

Name	Type	Required	Description
`id[]`	Array	No	The IDs of the custom fields to return or, where `query` is specified, filter.
`projectIds[]`	Array	No
`startAt`	Integer	No	The index of the first item to return in a page of results (page offset). Default value: 0
`query`	String	No	String used to perform a case-insensitive partial match with field names or descriptions.
`maxResults`	Integer	No	The maximum number of items to return per page. Default value: 50
`orderBy`	String	No	Order the results by: `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 Possible values: `"contextsCount"` `"-projectsCount"` `"-contextsCount"` `"projectsCount"` `"+screensCount"` `"+lastUsed"` `"+contextsCount"` `"screensCount"` `"name"` `"-name"` `"+projectsCount"` `"lastUsed"` `"-screensCount"` `"+name"` `"-lastUsed"`
`expand`	String	No	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 `stableId` returns the stableId 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
`type[]`	Array	No	The type of fields to search.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.