Issue field configurations

Get all field configurations

Changed on

Deprecated, use Field schemes which supports field association schemes.

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.

get/rest/api/3/fieldconfiguration

Request

  • Base URL
    https://your-domain.atlassian.net
  • URL
    https://your-domain.atlassian.net/rest/api/3/fieldconfiguration
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://auth.atlassian.com/authorize
      Token URL: https://auth.atlassian.com/oauth/token scopes: manage:jira-configuration

Query parameters

startAtinteger

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

maxResultsinteger

The maximum number of items to return per page.

idinteger[]

The list of field configuration IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001.

isDefaultboolean

If true returns default field configurations only.

querystring

The query string used to match against field configuration names and descriptions.

Response

Returned if the request is successful.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

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

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.

Changes