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

Atlassian Issue Fields API

The Issue Fields API from Atlassian — 8 operation(s) for issue fields.

Atlassian Issue Fields API is one of 183 APIs that Atlassian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 17 JSON Schema definitions.

Tagged areas include Issue Fields. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

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

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

9 operations 8 paths 15 schemas 1 DELETE4 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-67b5c6e5f3598d7ec1649016d026468ab2838a77
Server
https://your-domain.atlassian.net
Authentication
OAuth 2.0, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 2

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

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

Paths & Operations 9

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

Issue Fields 9
GET
/rest/api/3/field
Atlassian Get Fields
atlassianGetfields → 200401
POST
/rest/api/3/field
Atlassian Create Custom Field
atlassianCreatecustomfield body → 201400
GET
/rest/api/3/field/search
Atlassian Get Fields Paginated
atlassianGetfieldspaginated 7 params → 200400401403
GET
/rest/api/3/field/search/trashed
Atlassian Get Fields In Trash Paginated
atlassianGettrashedfieldspaginated 6 params → 200400401403
PUT
/rest/api/3/field/{fieldId}
Atlassian Update Custom Field
atlassianUpdatecustomfield 1 param body → 204400401403404
GET
/rest/api/3/field/{fieldId}/contextsdeprecated
Atlassian Get Contexts For A Field
atlassianGetcontextsforfielddeprecated 3 params → 200401403
DELETE
/rest/api/3/field/{id}
Atlassian Delete Custom Field
atlassianDeletecustomfield 1 param → 303400401403404409
POST
/rest/api/3/field/{id}/restore
Atlassian Restore Custom Field From Trash
atlassianRestorecustomfield 1 param → 200400401403404
POST
/rest/api/3/field/{id}/trash
Atlassian Move Custom Field To Trash
atlassianTrashcustomfield 1 param → 200400401403404

Schemas 15

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

Context
object
A context.
3 properties
AvatarUrlsBean
object
4 properties
Field
object
Details of a field.
12 properties 3 required
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
PageBeanField
object
A page of items.
7 properties
PageBeanContext
object
A page of items.
7 properties
UpdateCustomFieldDetails
object
Details of a custom field.
3 properties
ErrorCollection
object
Error messages from an operation.
3 properties
CustomFieldDefinitionJsonBean
object
4 properties 2 required
FieldLastUsed
object
Information about the most recent use of a field.
2 properties
UpdatedProjectCategory
object
A project category.
4 properties
TaskProgressBeanObject
object
Details about a task.
13 properties 8 required
ProjectDetails
object
Details about a project.
8 properties
JsonTypeBean
object
The schema of a field.
6 properties 1 required
FieldDetails
object
Details about a field.
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-issue-fields-api-openapi.yml Raw ↑

Other APIs Atlassian publishes across the network.

Atlassian Jira Software Backlog API
Atlassian Jira Software Board API
Atlassian Jira Software Epic API
Atlassian Jira Software Sprint API
Atlassian Jira Software Development Information API
Atlassian Jira Software Feature Flags API
Atlassian Jira Software Deployments API
Atlassian Jira Software Builds API
Atlassian Jira Software Remote Links API
Atlassian Jira Software Security Information API
Atlassian Jira Service Management Customer API
Atlassian Jira Service Management Info API
Where this information came from

This is an independent, third-party profile of Atlassian 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.