Bulk get custom field configurations

POST

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

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/rest/api/3/app/field/context/configuration/list' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fieldIdsOrKeys": [
        "customfield_10035",
        "customfield_10036"
    ]
}'

Response Example

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

Request

Query Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Returned if the request is successful.

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

Modified at 2025-07-16 07:18:01

Update announcement banner configuration

Get custom field configurations