provider Issue field configurations GET
/rest/api/3/fieldconfiguration @utdk/jira
/rest/api/3/fieldconfiguration Get all field configurations
Deprecated, use [ Field schemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes/#api-group-field-schemes) which supports field association schemes.
Returns a [paginated](#pagination) list of field configurations. The list can be for all field configurations or a subset determined by any combination of these criteria:
* a list of field configuration item IDs.
* whether the field configuration is a default.
* whether the field configuration name or description contains a query string.
Only field configurations used in company-managed (classic) projects are returned.
**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).
- startAt query
- The index of the first item to return in a page of results (page offset).
- integer
- maxResults query
- The maximum number of items to return per page.
- integer
- id query
- The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, `id=10000&id=10001`.
- array
- isDefault query
- If *true* returns default field configurations only.
- boolean
- query query
- The query string used to match against field configuration names and descriptions.
- string
Try it
Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.
Saved automatically to browser storage.
Code snippet
Updates live as you fill in the form above.
TypeScript
import jira from '@utdk/jira';
await jira.getallfieldconfigurations({
"startAt": 0,
"maxResults": 50,
"isDefault": false
})