Jira

Jira Field schemes API

This resource represents field schemes which are replacing field configuration schemes to control field associations. They are currently in beta and only available to customers who have opted-in to the beta program. For more information see [RFC-103: Jira Field Configuration Overhaul: Admin Experience and API Changes](https://community.developer.atlassian.com/t/rfc-103-jira-field-configuration-overhaul-admin-experience-and-api-changes/94205)

GitHub OpenAPI

Operations 15

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /rest/api/3/config/fieldschemes List field schemes · Get field schemes #
Ask an LLM
“What field schemes are set up on my Jira site?”
“Can I filter field schemes by project or by a text search on the name?”
Tell an agent
List all field association schemes.
Find field schemes used by project {projectId} matching {query}.
POST /rest/api/3/config/fieldschemes Create a new field scheme · Create field scheme #
Ask an LLM
“How do I create a brand new field scheme from scratch?”
“Does a newly created field scheme start with only a minimal set of default fields?”
Tell an agent
Create a field scheme named {name}.
Create field scheme {name} with description {description}.
DELETE /rest/api/3/config/fieldschemes/fields Remove fields from field schemes · Remove fields associated with field schemes #
Ask an LLM
“How can I take fields out of one or more field schemes?”
“Can I detach a field from multiple field association schemes at once?”
Tell an agent destructive · confirm first
Remove the specified fields from their field schemes.
Detach these fields from every field association scheme listed.
PUT /rest/api/3/config/fieldschemes/fields Update which fields belong to field schemes · Update fields associated with field schemes #
Ask an LLM
“Can I add fields to several field schemes in one go?”
“Is there a bulk way to change the field membership of field schemes?”
Tell an agent
Associate the listed fields with their field schemes.
Bulk update field memberships across my field association schemes.
DELETE /rest/api/3/config/fieldschemes/fields/parameters Remove field parameter overrides · Remove field parameters #
Ask an LLM
“How do I clear work type overrides on field parameters in a field scheme?”
“Can I reset a field's parameters back to the scheme default for certain work types?”
Tell an agent destructive · confirm first
Remove the field parameter overrides for the given work types.
Clear work-type specific parameter overrides from field schemes.
PUT /rest/api/3/config/fieldschemes/fields/parameters Update field parameters in field schemes · Update field parameters #
Ask an LLM
“Can I override a field's parameters, like required or description, per work type in a field scheme?”
“Which call changes field item parameters inside field association schemes?”
Tell an agent
Update the field parameter overrides in my field schemes.
Set new work-type parameter values for fields in field association schemes.
GET /rest/api/3/config/fieldschemes/projects Get field schemes assigned to projects · Get projects with field schemes #
Ask an LLM
“Which field scheme is each of my projects using?”
“Can I check field scheme assignments while migrating off legacy field configurations?”
Tell an agent
Show the field schemes for projects {projectId}.
Look up which field association scheme project {projectId} is on.
PUT /rest/api/3/config/fieldschemes/projects Assign projects to field schemes · Associate projects to field schemes #
Ask an LLM
“How do I switch a project to a different field scheme?”
“Can I associate several projects with field schemes in one request?”
Tell an agent
Associate the listed projects with their field schemes.
Move these projects onto the specified field association schemes.
DELETE /rest/api/3/config/fieldschemes/{id} Delete a field scheme · Delete a field scheme #
Ask an LLM
“How do I delete a field scheme I no longer use?”
“Can a field association scheme be removed permanently?”
Tell an agent destructive · confirm first
Delete field scheme {id}.
Permanently remove field association scheme {id}.
GET /rest/api/3/config/fieldschemes/{id} Get a field scheme by ID · Get field scheme #
Ask an LLM
“What are the name and description of a specific field scheme?”
“Can I fetch a single field association scheme by its ID?”
Tell an agent
Get field scheme {id}.
Show me the details of field association scheme {id}.
PUT /rest/api/3/config/fieldschemes/{id} Rename or redescribe a field scheme · Update field scheme #
Ask an LLM
“Can I rename an existing field scheme?”
“How would I change the description on a field scheme?”
Tell an agent
Rename field scheme {id} to {name}.
Update the description of field scheme {id} to {description}.
POST /rest/api/3/config/fieldschemes/{id}/clone Clone a field scheme · Clone field scheme #
Ask an LLM
“Can I copy an existing field scheme into a new one?”
“What's the way to duplicate a field scheme under a new name?”
Tell an agent
Clone field scheme {id} as {name}.
Make a copy of field association scheme {id} named {name} with description {description}.
GET /rest/api/3/config/fieldschemes/{id}/fields Search fields in a field scheme · Search field scheme fields #
Ask an LLM
“Which fields belong to a particular field scheme?”
“Can I check whether a specific field is part of a field scheme?”
Tell an agent
List the fields in field scheme {id}.
Check if field {fieldId} is in field scheme {id}.
GET /rest/api/3/config/fieldschemes/{id}/fields/{fieldId}/parameters Get a field's parameters in a field scheme · Get field parameters #
Ask an LLM
“What parameter overrides does a field have inside a given field scheme?”
“Is a field marked required for certain work types in a field scheme?”
Tell an agent
Get the parameters of field {fieldId} in field scheme {id}.
Show work-type overrides for field {fieldId} on scheme {id}.
GET /rest/api/3/config/fieldschemes/{id}/projects Search projects using a field scheme · Search field scheme projects #
Ask an LLM
“Which projects are using a given field scheme?”
“Can I check whether one project belongs to a field scheme?”
Tell an agent
List the projects on field scheme {id}.
Check if project {projectId} is associated with field scheme {id}.

Documentation

📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/
📖
Authentication
https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#authentication
📖
Documentation
https://developer.atlassian.com/cloud/jira/software/rest/intro/
📖
Documentation
https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/
📖
APIReference
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-field-schemes-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/jira:jira-field-schemes-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

jira-field-schemes-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: ecosystem@atlassian.com
  description: Jira Cloud platform REST API documentation
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/
  title: Jira Cloud platform REST Field schemes API
  version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
servers:
- url: https://your-domain.atlassian.net
tags:


# --- truncated at 32 KB (93 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-field-schemes-api-openapi.yml