GET /rest/api/2/fieldconfiguration
Returns a paginated 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 required: Administer Jira global permission.
Servers
- https://your-domain.atlassian.net
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
id[] |
Array | No |
The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, |
startAt |
Integer | No |
The index of the first item to return in a page of results (page offset). Default value: 0 |
query |
String | No |
The query string used to match against field configuration names and descriptions. |
maxResults |
Integer | No |
The maximum number of items to return per page. Default value: 50 |
isDefault |
Boolean | No |
If true returns default field configurations only. Default value: false |
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.