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 fields API

This resource represents issue fields, both system and custom fields. Use it to get fields, field configurations, and create custom fields.

Jira Issue fields 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 Fields. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

This API exposes 11 operations across 10 paths, and defines 19 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.

11 operations 10 paths 19 schemas 1 DELETE6 GET3 POST1 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 fields 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 11

Across 10 paths, the API surfaces 11 operations — 1 DELETE, 6 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Issue Fields 11

This resource represents issue fields, both system and custom fields. Use it to get fields, field configurations, and create custom fields.

GET
/rest/api/3/field
Get fields
getFields → 200401
POST
/rest/api/3/field
Create custom field
createCustomField body → 201400
GET
/rest/api/3/field/search
Get fields paginated
getFieldsPaginated 8 params → 200400401403
GET
/rest/api/3/field/search/trashed
Get fields in trash paginated
getTrashedFieldsPaginated 6 params → 200400401403
PUT
/rest/api/3/field/{fieldId}
Update custom field
updateCustomField 1 param body → 204400401403404
GET
/rest/api/3/field/{fieldId}/association/project
Get field project associations
getFieldProjectAssociations 3 params → 200400401403
GET
/rest/api/3/field/{fieldId}/contextsdeprecated
Get contexts for a field
getContextsForFieldDeprecated 3 params → 200401403
DELETE
/rest/api/3/field/{id}
Delete custom field
deleteCustomField 1 param → 303400401403404409
POST
/rest/api/3/field/{id}/restore
Restore custom field from trash
restoreCustomField 1 param → 200400401403404
POST
/rest/api/3/field/{id}/trash
Move custom field to trash
trashCustomField 1 param → 200400401403404
GET
/rest/api/3/projects/fields
Get fields for projects
getProjectFields 5 params → 200400401403404

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Field (16 properties), TaskProgressBeanObject (13 properties), FieldDetails (10 properties), ProjectDetails (8 properties). Each schema is shown below with its type and property counts.

JsonTypeBean
object
The schema of a field.
6 properties 1 required
UpdateCustomFieldDetails
object
Details of a custom field.
3 properties
PageBeanField
object
A page of items.
7 properties
ErrorCollection
object
Error messages from an operation.
3 properties
CustomFieldDefinitionJsonBean
object
4 properties 2 required
PageBeanFieldProjectAssociation
object
A page of items.
7 properties
FieldDetails
object
Details about a field.
10 properties
ProjectFieldBean
object
5 properties
TaskProgressBeanObject
object
Details about a task.
13 properties 8 required
PageBean2ProjectFieldBean
object
A page of items.
7 properties
FieldLastUsed
object
Information about the most recent use of a field.
2 properties
AvatarUrlsBean
object
4 properties
PageBeanContext
object
A page of items.
7 properties
ProjectDetails
object
Details about a project.
8 properties
Field
object
Details of a field.
16 properties 3 required
FieldProjectAssociation
object
List of project associations.
1 property
Scope
object
The projects the item is associated with. Indicated for items associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO).
2 properties
UpdatedProjectCategory
object
A project category.
4 properties
Context
object
A context.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jira-issue-fields-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 fields 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.