Sign in

v5

latestOpenAPI 3.0.1Apache 2.02026-08-046169702.3 MB
Issue custom field configuration (apps)

Bulk get custom field configurations

Returns a paginated list of configurations for list of custom fields of a type created by a Forge app.

The result can be filtered by one of these criteria:

  • id.
  • fieldContextId.
  • issueId.
  • projectKeyOrId and issueTypeId.

Otherwise, all configurations for the provided list of custom fields are returned.

Permissions required: Administer Jira global permission. Jira permissions are not required for the Forge app that provided the custom field type.

post/rest/api/3/app/field/context/configuration/list

Query parameters

idinteger[]

The list of configuration IDs. To include multiple configurations, separate IDs with an ampersand: id=10000&id=10001. Can't be provided with fieldContextId, issueId, projectKeyOrId, or issueTypeId.

fieldContextIdinteger[]

The list of field context IDs. To include multiple field contexts, separate IDs with an ampersand: fieldContextId=10000&fieldContextId=10001. Can't be provided with id, issueId, projectKeyOrId, or issueTypeId.

issueIdinteger

The ID of the issue to filter results by. If the issue doesn't exist, an empty list is returned. Can't be provided with projectKeyOrId, or issueTypeId.

projectKeyOrIdstring

The ID or key of the project to filter results by. Must be provided with issueTypeId. Can't be provided with issueId.

issueTypeIdstring

The ID of the issue type to filter results by. Must be provided with projectKeyOrId. Can't be provided with issueId.

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.

Request body

fieldIdsOrKeysstring[] required

List of IDs or keys of the custom fields. It can be a mix of IDs and keys in the same query.

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.