How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Jira Issue field configurations API

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

Jira Issue field configurations API is one of 132 APIs that Jira publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Issue Field Configurations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

This API exposes 15 operations across 9 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df.

Requests are made against a single base URL, https://your-domain.atlassian.net.

15 operations 9 paths 18 schemas 2 DELETE5 GET3 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
Base URL
https://your-domain.atlassian.net/rest/api/2
Authentication
OAuth 2.0, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Jira Issue field configurations API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 186 scopes. It accepts HTTP basic authentication (basicAuth).

  • OAuth2 — OAuth2 scopes for Jira
  • basicAuth — You can access this resource via basic auth.

Paths & Operations 15

Across 9 paths, the API surfaces 15 operations — 2 DELETE, 5 GET, 3 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Issue Field Configurations 15

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

GET
/rest/api/3/fieldconfigurationdeprecated
Get all field configurations
getAllFieldConfigurations 5 params → 200401403
POST
/rest/api/3/fieldconfigurationdeprecated
Create field configuration
createFieldConfiguration body → 200400401403
DELETE
/rest/api/3/fieldconfiguration/{id}deprecated
Delete field configuration
deleteFieldConfiguration 1 param → 204400401403404
PUT
/rest/api/3/fieldconfiguration/{id}deprecated
Update field configuration
updateFieldConfiguration 1 param body → 204400401403404
GET
/rest/api/3/fieldconfiguration/{id}/fieldsdeprecated
Get field configuration items
getFieldConfigurationItems 3 params → 200401403404
PUT
/rest/api/3/fieldconfiguration/{id}/fieldsdeprecated
Update field configuration items
updateFieldConfigurationItems 1 param body → 204400401403404
GET
/rest/api/3/fieldconfigurationschemedeprecated
Get all field configuration schemes
getAllFieldConfigurationSchemes 3 params → 200400401403
POST
/rest/api/3/fieldconfigurationschemedeprecated
Create field configuration scheme
createFieldConfigurationScheme body → 201400401403
GET
/rest/api/3/fieldconfigurationscheme/mappingdeprecated
Get field configuration issue type items
getFieldConfigurationSchemeMappings 3 params → 200400401403404
GET
/rest/api/3/fieldconfigurationscheme/projectdeprecated
Get field configuration schemes for projects
getFieldConfigurationSchemeProjectMapping 3 params → 200400401403
PUT
/rest/api/3/fieldconfigurationscheme/projectdeprecated
Assign field configuration scheme to project
assignFieldConfigurationSchemeToProject body → 204400401403404
DELETE
/rest/api/3/fieldconfigurationscheme/{id}deprecated
Delete field configuration scheme
deleteFieldConfigurationScheme 1 param → 204400401403404
PUT
/rest/api/3/fieldconfigurationscheme/{id}deprecated
Update field configuration scheme
updateFieldConfigurationScheme 1 param body → 204400401403404
PUT
/rest/api/3/fieldconfigurationscheme/{id}/mappingdeprecated
Assign issue types to field configurations
setFieldConfigurationSchemeMapping 1 param body → 204400401403404
POST
/rest/api/3/fieldconfigurationscheme/{id}/mapping/deletedeprecated
Remove issue types from field configuration scheme
removeIssueTypesFromGlobalFieldConfigurationScheme 1 param body → 204400401403404

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are PageBeanFieldConfigurationIssueTypeItem (7 properties), PageBeanFieldConfigurationScheme (7 properties), PageBeanFieldConfigurationSchemeProjects (7 properties), PageBeanFieldConfigurationDetails (7 properties). Each schema is shown below with its type and property counts.

AssociateFieldConfigurationsWithIssueTypesRequest
object
Details of a field configuration to issue type mappings.
1 property 1 required
ErrorCollection
object
Error messages from an operation.
3 properties
FieldConfigurationToIssueTypeMapping
object
The field configuration to issue type mapping.
2 properties 2 required
FieldConfigurationDetails
object
Details of a field configuration.
2 properties 1 required
UpdateFieldConfigurationSchemeDetails
object
The details of the field configuration scheme.
2 properties 1 required
FieldConfigurationIssueTypeItem
object
The field configuration for an issue type.
3 properties 3 required
FieldConfigurationSchemeProjectAssociation
object
Associated field configuration scheme and project.
2 properties 1 required
PageBeanFieldConfigurationItem
object
A page of items.
7 properties
FieldConfigurationSchemeProjects
object
Project list with assigned field configuration schema.
2 properties 1 required
PageBeanFieldConfigurationDetails
object
A page of items.
7 properties
PageBeanFieldConfigurationSchemeProjects
object
A page of items.
7 properties
FieldConfigurationItemsDetails
object
Details of field configuration items.
1 property 1 required
FieldConfigurationScheme
object
Details of a field configuration scheme.
3 properties 2 required
PageBeanFieldConfigurationIssueTypeItem
object
A page of items.
7 properties
FieldConfiguration
object
Details of a field configuration.
4 properties 3 required
FieldConfigurationItem
object
A field within a field configuration.
5 properties 1 required
PageBeanFieldConfigurationScheme
object
A page of items.
7 properties
IssueTypeIdsToRemove
object
The list of issue type IDs to be removed from the field configuration scheme.
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jira-issue-field-configurations-api-openapi.yml Raw ↑

Other APIs Jira publishes across the network.

Jira Cloud Platform REST API v2
Jira Service Management Operations REST API
Jira Align REST API
Jira Customer Service Management REST API
Jira Issue Comments API
Jira Issue Priorities API
Jira Issue Search API
Jira Issue Statuses API
Jira Issue Transitions API
Jira Issue Types API
Jira Issues API
Jira Projects API
Where this information came from

This is an independent, third-party profile of Jira Issue field configurations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.