v4

OpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB

Field schemes

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 required: Administer Jira global permission.

get/rest/api/3/config/fieldschemes

Query parameters

projectIdinteger[]

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

querystring

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

startAtinteger

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

maxResultsinteger

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

Response

Pagianted list of field association schemes

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

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

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.