Get custom field configurations

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

The result can be filtered by one of these criteria:

id.

fieldContextId.

issueId.

projectKeyOrId and issueTypeId.

Otherwise, all configurations are returned.

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

{ "maxResults": 1000, "startAt": 0, "total": 2, "isLast": true, "values": [ { "id": "10000", "fieldContextId": "10010" }, { "id": "10001", "fieldContextId": "10011", "configuration": { "minValue": 0, "maxValue": 10000 }, "schema": { "properties": { "amount": { "type": "number" }, "currency": { "type": "string" } }, "required": [ "amount", "currency" ] } } ] }

Request

Path Params

fieldIdOrKey

string

required

The ID or key of the custom field, for example customfield_10000.

Query Params

array[string]

optional

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.

fieldContextId

array[string]

optional

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.

issueId

integer

optional

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.

projectKeyOrId

string

optional

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

issueTypeId

string

optional

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

startAt

integer

optional

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

maxResults

integer

optional

The maximum number of items to return per page.

Responses

🟢200Returned if the request is successful.

application/json

Body

A page of items.

isLast

boolean

read-onlyoptional

Whether this is the last page.

maxResults

integer <int32>

read-onlyoptional

The maximum number of items that could be returned.

string <uri>

read-onlyoptional

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

self

string <uri>

read-onlyoptional

The URL of the page.

startAt

integer <int64>

read-onlyoptional

The index of the first item returned.

total

integer <int64>

read-onlyoptional

The number of items returned.

values

array[object (ContextualConfiguration) {4}]

read-onlyoptional

The list of items.

configuration

optional

The field configuration.

fieldContextId

string

read-onlyrequired

The ID of the field context the configuration is associated with.

string

required

The ID of the configuration.

schema

optional

The field value schema.

🟠400Returned if the request is invalid.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if the user is not a Jira admin or the request is not authenticated as from the app that provided the field.

🟠404Returned if the custom field is not found.