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 Custom Field Options API

The Issue Custom Field Options API from Atlassian — 4 operation(s) for issue custom field options.

Atlassian Issue Custom Field Options 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 Custom Field Options. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

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

6 operations 4 paths 10 schemas 1 DELETE2 GET1 POST2 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 Custom Field Options 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 6

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

Issue Custom Field Options 6
GET
/rest/api/3/customFieldOption/{id}
Atlassian Get Custom Field Option
atlassianGetcustomfieldoption 1 param → 200401404
GET
/rest/api/3/field/{fieldId}/context/{contextId}/option
Atlassian Get Custom Field Options Context
atlassianGetoptionsforcontext 6 params → 200400401403404
POST
/rest/api/3/field/{fieldId}/context/{contextId}/option
Atlassian Create Custom Field Options Context
atlassianCreatecustomfieldoption 2 params body → 200400401403404
PUT
/rest/api/3/field/{fieldId}/context/{contextId}/option
Atlassian Update Custom Field Options Context
atlassianUpdatecustomfieldoption 2 params body → 200400401403404
PUT
/rest/api/3/field/{fieldId}/context/{contextId}/option/move
Atlassian Reorder Custom Field Options Context
atlassianReordercustomfieldoptions 2 params body → 204400401403404
DELETE
/rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId}
Atlassian Delete Custom Field Options Context
atlassianDeletecustomfieldoption 3 params → 204400401403404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are PageBeanCustomFieldContextOption (7 properties), CustomFieldContextOption (4 properties), CustomFieldOptionUpdate (3 properties), OrderOfCustomFieldOptions (3 properties). Each schema is shown below with its type and property counts.

CustomFieldCreatedContextOptionsList
object
A list of custom field options for a context.
1 property
OrderOfCustomFieldOptions
object
An ordered list of custom field option IDs and information on where to move them.
3 properties 1 required
CustomFieldOptionUpdate
object
Details of a custom field option for a context.
3 properties 1 required
CustomFieldContextOption
object
Details of the custom field options for a context.
4 properties 3 required
CustomFieldUpdatedContextOptionsList
object
A list of custom field options for a context.
1 property
CustomFieldOptionCreate
object
Details of a custom field option to create.
3 properties 1 required
PageBeanCustomFieldContextOption
object
A page of items.
7 properties
BulkCustomFieldOptionUpdateRequest
object
Details of the options to update for a custom field.
1 property
CustomFieldOption
object
Details of a custom option for a field.
2 properties
BulkCustomFieldOptionCreateRequest
object
Details of the options to create for a custom field.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-issue-custom-field-options-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 Custom Field Options 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.