Jira

Jira Issue field configurations API

This resource represents issue field configurations. Use it to get, set, and delete field configurations and field configuration schemes.

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/fieldconfiguration List field configurations · Get all field configurations #
Ask an LLM
“Which field configurations exist in my Jira site?”
“Can I list only the default field configuration, or search them by name?”
Tell an agent
List all field configurations.
Find field configurations whose name or description contains {query}.
POST /rest/api/3/fieldconfiguration Create a field configuration · Create field configuration #
Ask an LLM
“How do I create a new field configuration in company-managed Jira?”
“What do I need to supply to add a field configuration?”
Tell an agent
Create a field configuration named {name}.
Add field configuration {name} described as {description}.
DELETE /rest/api/3/fieldconfiguration/{id} Delete a field configuration · Delete field configuration #
Ask an LLM
“Can I delete a field configuration that is no longer used?”
“Which field configurations am I not allowed to delete?”
Tell an agent destructive · confirm first
Delete field configuration {id}.
Remove the unused field configuration {id}.
PUT /rest/api/3/fieldconfiguration/{id} Rename or redescribe a field configuration · Update field configuration #
Ask an LLM
“How do I rename an existing field configuration?”
“Can I change the description of a field configuration I already have?”
Tell an agent
Rename field configuration {id} to {name}.
Update field configuration {id} with name {name} and description {description}.
GET /rest/api/3/fieldconfiguration/{id}/fields List the fields in a field configuration · Get field configuration items #
Ask an LLM
“Which fields are hidden or required in a given field configuration?”
“How do I see the per-field settings inside a field configuration?”
Tell an agent
List the fields in field configuration {id}.
Show required and hidden settings for fields in configuration {id}.
PUT /rest/api/3/fieldconfiguration/{id}/fields Change field settings in a field configuration · Update field configuration items #
Ask an LLM
“How do I make a field required or hidden within a field configuration?”
“Can I change a field's renderer or description in a field configuration?”
Tell an agent
Update fields {fieldConfigurationItems} in field configuration {id}.
Apply field settings {fieldConfigurationItems} to configuration {id}.
GET /rest/api/3/fieldconfigurationscheme List field configuration schemes · Get all field configuration schemes #
Ask an LLM
“What field configuration schemes are defined in my Jira instance?”
“Can I look up specific field configuration schemes by ID?”
Tell an agent
List all field configuration schemes.
Show field configuration scheme {id}.
POST /rest/api/3/fieldconfigurationscheme Create a field configuration scheme · Create field configuration scheme #
Ask an LLM
“How do I create a new field configuration scheme?”
“Is a name all I need to make a field configuration scheme?”
Tell an agent
Create a field configuration scheme named {name}.
Add scheme {name} with description {description}.
GET /rest/api/3/fieldconfigurationscheme/mapping List issue type mappings in configuration schemes · Get field configuration issue type items #
Ask an LLM
“Which issue types map to which field configurations inside a scheme?”
“How do I see the issue type to field configuration items for a scheme?”
Tell an agent
Show issue type mappings for field configuration scheme {fieldConfigurationSchemeId}.
List every issue type to field configuration mapping across schemes.
GET /rest/api/3/fieldconfigurationscheme/project Find field configuration schemes used by projects · Get field configuration schemes for projects #
Ask an LLM
“Which field configuration scheme is a given project using?”
“Can I check the field configuration schemes for several projects at once?”
Tell an agent
Show the field configuration scheme for project {projectId}.
Look up the field configuration schemes used by projects {projectId}.
PUT /rest/api/3/fieldconfigurationscheme/project Assign a field configuration scheme to a project · Assign field configuration scheme to project #
Ask an LLM
“How do I switch a project to a different field configuration scheme?”
“Can I put a project back on the default field configuration scheme?”
Tell an agent
Assign field configuration scheme {fieldConfigurationSchemeId} to project {projectId}.
Reset project {projectId} to the default field configuration scheme.
DELETE /rest/api/3/fieldconfigurationscheme/{id} Delete a field configuration scheme · Delete field configuration scheme #
Ask an LLM
“Can I delete a field configuration scheme that no project uses?”
“What happens if I try to remove a field configuration scheme?”
Tell an agent destructive · confirm first
Delete field configuration scheme {id}.
Remove the field configuration scheme {id} permanently.
PUT /rest/api/3/fieldconfigurationscheme/{id} Rename a field configuration scheme · Update field configuration scheme #
Ask an LLM
“How do I rename a field configuration scheme?”
“Can I update the description of an existing field configuration scheme?”
Tell an agent
Rename field configuration scheme {id} to {name}.
Update scheme {id} with name {name} and description {description}.
PUT /rest/api/3/fieldconfigurationscheme/{id}/mapping Map issue types to field configurations in a scheme · Assign issue types to field configurations #
Ask an LLM
“How do I make bugs use a different field configuration within a scheme?”
“Can I set the default field configuration for a scheme's issue types?”
Tell an agent
Set mappings {mappings} on field configuration scheme {id}.
Assign issue types to field configurations in scheme {id} using {mappings}.
POST /rest/api/3/fieldconfigurationscheme/{id}/mapping/delete Remove issue types from a field configuration scheme · Remove issue types from field configuration scheme #
Ask an LLM
“How do I drop issue type mappings from a field configuration scheme?”
“Can I unmap several issue types from a scheme in one call?”
Tell an agent destructive · confirm first
Remove issue types {issueTypeIds} from field configuration scheme {id}.
Unmap {issueTypeIds} from 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-issue-field-configurations-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-issue-field-configurations-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-issue-field-configurations-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 Issue field configurations API
  version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
servers:
- url: https://your-domain.atlassian.net
tags:


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