---
title: "Get custom field configurations"
method: GET
path: "/rest/api/2/app/field/{fieldIdOrKey}/context/configuration"
tags: ["Issue custom field configuration (apps)"]
---

# Get custom field configurations

`GET /rest/api/2/app/field/{fieldIdOrKey}/context/configuration`

Returns a [paginated](#pagination) list of configurations for a custom field of a [type](https://developer.atlassian.com/platform/forge/manifest-reference/modules/jira-custom-field-type/) created by a [Forge app](https://developer.atlassian.com/platform/forge/).

The result can be filtered by one of these criteria:

 *  `id`.
 *  `fieldContextId`.
 *  `issueId`.
 *  `projectKeyOrId` and `issueTypeId`.

Otherwise, all configurations are returned.

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). Jira permissions are not required for the Forge app that provided the custom field type.

## Path parameters

- `fieldIdOrKey` string, required

## Query parameters

- `id` integer[]
- `fieldContextId` integer[]
- `issueId` integer
- `projectKeyOrId` string
- `issueTypeId` string
- `startAt` integer
- `maxResults` integer

## Response `200`

Returned if the request is successful.

- PageBeanContextualConfiguration — A page of items.
  - `isLast` boolean — Whether this is the last page.
  - `maxResults` integer — The maximum number of items that could be returned.
  - `nextPage` string, uri — If there is another page of results, the URL of the next page.
  - `self` string, uri — The URL of the page.
  - `startAt` integer — The index of the first item returned.
  - `total` integer — The number of items returned.
  - `values` ContextualConfiguration[] — The list of items.
    - `configuration` unknown
    - `fieldContextId` string, required — The ID of the field context the configuration is associated with.
    - `id` string, required — The ID of the configuration.
    - `schema` unknown

## Other responses

- `400` — Returned if the request is invalid.
- `401` — Returned if the authentication credentials are incorrect or missing.
- `403` — Returned if the user is not a Jira admin or the request is not authenticated as from the app that provided the field.
- `404` — Returned if the custom field is not found.

---

[API](https://skmtc.dev/atlassian/apis/the-jira-cloud-platform-rest-api.md) · [All operations](https://skmtc.dev/atlassian/apis/the-jira-cloud-platform-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api/revisions/7e9af75061ea/schema)