GET /rest/api/2/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 required: Administer Jira global permission.
Servers
- https://your-domain.atlassian.net
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
projectId[] |
Array | No |
(optional) List of project IDs to filter schemes by. If not provided, schemes from all projects are returned. |
startAt |
Integer | No |
Zero-based index of the first item to return (default: 0) Default value: 0 |
query |
String | No |
(optional) Text filter for scheme name or description matching (case-insensitive). If not provided, no text filtering is applied. |
maxResults |
Integer | No |
Maximum number of items to return per page (default: 50, max: 100) Default value: 50 |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.