---
title: "Get field schemes"
method: GET
path: "/rest/api/3/config/fieldschemes"
tags: ["Field schemes"]
---

# Get field schemes

`GET /rest/api/3/config/fieldschemes`

REST endpoint for retrieving a paginated list of field association schemes with optional filtering.

This endpoint allows clients to fetch field association schemes with optional filtering by project IDs and text queries. The response includes scheme details with navigation links and filter metadata when applicable.

Filtering Behavior:

 *  When projectId or query parameters are provided, the response includes matchedFilters metadata showing which filters were applied.
 *  When no filters are applied, matchedFilters is omitted from individual scheme objects

**[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg).

## Query parameters

- `projectId` integer[]
- `query` string
- `startAt` integer
- `maxResults` integer

## Response `200`

Pagianted list of field association schemes

- PageBean2GetFieldAssociationSchemeResponse — 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` GetFieldAssociationSchemeResponse[] — The list of items.
    - `description` string
    - `fieldsCount` integer
    - `id` integer
    - `isDefault` boolean
    - `links` FieldAssociationSchemeLinksBean
      - `associations` string
      - `projects` string
    - `matchedFilters` FieldAssociationSchemeMatchedFilters — Matched filters for field association scheme search.
      - `projectIds` integer[]
      - `query` string
    - `name` string

## Other responses

- `400` — Returned if the request parameters are invalid (e.g., negative startAt, maxResults exceeding limit).
- `401` — Returned if the authentication credentials are incorrect or missing.
- `403` — Returned if the user does not have the required permissions.
- `404` — Returned if the feature flag is disabled.

---

[API](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2.md) · [All operations](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api-2/versions/5a51740d7ab3/schema)