provider Field schemes GET /rest/api/3/config/fieldschemes
@utdk/jira /rest/api/3/config/fieldschemes
Get field schemes
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).
projectId query
(optional) List of project IDs to filter schemes by. If not provided, schemes from all projects are returned.
array
query query
(optional) Text filter for scheme name or description matching (case-insensitive). If not provided, no text filtering is applied.
string
startAt query
Zero-based index of the first item to return (default: 0)
integer
maxResults query
Maximum number of items to return per page (default: 50, max: 100)
integer

Try it

Authentication
Configure credentials for The Jira Cloud platform REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getfieldassociationschemes
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).

(optional) List of project IDs to filter schemes by. If not provided, schemes from all projects are returned.

(optional) Text filter for scheme name or description matching (case-insensitive). If not provided, no text filtering is applied.

Zero-based index of the first item to return (default: 0)

Maximum number of items to return per page (default: 50, max: 100)

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import jira from '@utdk/jira';

await jira.getfieldassociationschemes({
  "startAt": 0,
  "maxResults": 50
})