Atlassian Issue Field Configurations API

The Issue Field Configurations API from Atlassian — 9 operation(s) for issue field configurations.

Documentation 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 · Atlassian Get All Field Configurations #

Ask an LLM

“What field configurations exist in my Jira site?”

“Can I find 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 · Atlassian Create Field Configuration #

Ask an LLM

“How do I create a new field configuration for a classic project?”

“Does a new field configuration start with every field optional?”

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 · Atlassian Delete Field Configuration #

Ask an LLM

“How do I remove a field configuration we no longer need?”

“Can field configurations from team-managed projects be deleted here?”

Tell an agent destructive · confirm first

Delete field configuration {id}.

Remove the unused field configuration {id} from Jira.

PUT /rest/api/3/fieldconfiguration/{id} Rename or redescribe a field configuration · Atlassian Update Field Configuration #

Ask an LLM

“Can I rename an existing field configuration?”

“Is changing a field configuration's description limited to classic projects?”

Tell an agent

Rename field configuration {id} to {name}.

Set field configuration {id}'s name to {name} and description to {description}.

GET /rest/api/3/fieldconfiguration/{id}/fields List fields in a field configuration · Atlassian Get Field Configuration Items #

Ask an LLM

“Which fields are required or hidden in a particular field configuration?”

“What settings does each field have inside one field configuration?”

Tell an agent

List the fields and their settings in field configuration {id}.

Show {maxResults} fields from field configuration {id}.

PUT /rest/api/3/fieldconfiguration/{id}/fields Change field settings in a field configuration · Atlassian Update Field Configuration Items #

Ask an LLM

“How do I make a field required or hidden in a field configuration?”

“Can I change a field's renderer or description within a configuration?”

Tell an agent

Update fields in field configuration {id} with {fieldConfigurationItems}.

Mark the fields in {fieldConfigurationItems} as required within field configuration {id}.

GET /rest/api/3/fieldconfigurationscheme List field configuration schemes · Atlassian Get All Field Configuration Schemes #

Ask an LLM

“What field configuration schemes are set up for classic projects?”

“Can I fetch specific field configuration schemes by ID?”

Tell an agent

List all field configuration schemes.

Get field configuration schemes with IDs {id}.

POST /rest/api/3/fieldconfigurationscheme Create a field configuration scheme · Atlassian Create Field Configuration Scheme #

Ask an LLM

“How do I create a field configuration scheme for company-managed projects?”

“Can I give a new field configuration scheme a description?”

Tell an agent

Create a field configuration scheme named {name}.

Add field configuration scheme {name} with description {description}.

GET /rest/api/3/fieldconfigurationscheme/mapping List issue type to field configuration mappings · Atlassian Get Field Configuration Issue Type Items #

Ask an LLM

“Which field configuration does each issue type use in a scheme?”

“Can I see the issue type mappings for one field configuration scheme?”

Tell an agent

Show the issue type mappings in field configuration scheme {fieldConfigurationSchemeId}.

List all field configuration issue type items.

GET /rest/api/3/fieldconfigurationscheme/project Find the field configuration scheme a project uses · Atlassian Get Field Configuration Schemes For Projects #

Ask an LLM

“Which field configuration scheme is my project assigned to?”

“What projects share each field configuration scheme?”

Tell an agent

Get the field configuration scheme for project {projectId}.

Show field configuration schemes and the projects using them for projects {projectId}.

PUT /rest/api/3/fieldconfigurationscheme/project Assign a field configuration scheme to a project · Atlassian Assign Field Configuration Scheme To Project #

Ask an LLM

“How do I switch a classic 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 · Atlassian Delete Field Configuration Scheme #

Ask an LLM

“How do I delete a field configuration scheme?”

“Is it possible to remove a scheme used only by classic projects?”

Tell an agent destructive · confirm first

Delete field configuration scheme {id}.

Remove the obsolete field configuration scheme {id}.

PUT /rest/api/3/fieldconfigurationscheme/{id} Rename a field configuration scheme · Atlassian Update Field Configuration Scheme #

Ask an LLM

“Can I rename a field configuration scheme after creating it?”

“How do I change the description on a field configuration scheme?”

Tell an agent

Rename field configuration scheme {id} to {name}.

Update field configuration scheme {id} with name {name} and description {description}.

PUT /rest/api/3/fieldconfigurationscheme/{id}/mapping Map issue types to field configurations in a scheme · Atlassian Assign Issue Types To Field Configurations #

Ask an LLM

“How do I make bugs use a different field configuration than tasks?”

“Can I assign several issue types to field configurations in one scheme call?”

Tell an agent

Apply issue type mappings {mappings} to 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 · Atlassian Remove Issue Types From Field Configuration Scheme #

Ask an LLM

“How do I unmap issue types from a field configuration scheme?”

“Can I drop several issue types from a scheme's mappings at once?”

Tell an agent destructive · confirm first

Remove issue types {issueTypeIds} from field configuration scheme {id}.

Unmap issue types {issueTypeIds} in scheme {id}.

Atlassian Issue Field Configurations API

Operations 15

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification