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 custom field options API

This resource represents custom issue field select list options created in Jira or using the REST API. This resource supports the following field types: * Checkboxes. * Radio Buttons. * Select List (single choice). * Select List (multiple choices). * Select List (cascading).See [Issue custom field options (apps)](#api-group-Issue-custom-field-options--apps-) to manipulate custom issue field select list options created by a Connect app.Use it to retrieve, create, update, order, and delete custom field options.

Jira Issue custom field options 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 Custom Field Options. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and an API reference.

This API exposes 7 operations across 5 paths, and defines 13 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.

7 operations 5 paths 13 schemas 2 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-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 custom field options 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 7

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

Issue Custom Field Options 7

This resource represents custom issue field select list options created in Jira or using the REST API. This resource supports the following field types: Checkboxes. Radio Buttons.…

GET
/rest/api/3/customFieldOption/{id}
Get custom field option
getCustomFieldOption 1 param → 200401404
GET
/rest/api/3/field/{fieldId}/context/{contextId}/option
Get custom field options (context)
getOptionsForContext 6 params → 200400401403404
POST
/rest/api/3/field/{fieldId}/context/{contextId}/option
Create custom field options (context)
createCustomFieldOption 2 params body → 200400401403404
PUT
/rest/api/3/field/{fieldId}/context/{contextId}/option
Update custom field options (context)
updateCustomFieldOption 2 params body → 200400401403404
PUT
/rest/api/3/field/{fieldId}/context/{contextId}/option/move
Reorder custom field options (context)
reorderCustomFieldOptions 2 params body → 204400401403404
DELETE
/rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId}
Delete custom field options (context)
deleteCustomFieldOption 3 params → 204400401403404
DELETE
/rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId}/issue
Replace custom field options
replaceCustomFieldOption 5 params → 303400403404

Schemas 13

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

TaskProgressBeanRemoveOptionFromIssuesResult
object
Details about a task.
13 properties 8 required
CustomFieldCreatedContextOptionsList
object
A list of custom field options for a context.
1 property
PageBeanCustomFieldContextOption
object
A page of items.
7 properties
BulkCustomFieldOptionCreateRequest
object
Details of the options to create for a custom field.
1 property
RemoveOptionFromIssuesResult
object
3 properties
CustomFieldOptionUpdate
object
Details of a custom field option for a context.
3 properties 1 required
OrderOfCustomFieldOptions
object
An ordered list of custom field option IDs and information on where to move them.
3 properties 1 required
CustomFieldOptionCreate
object
Details of a custom field option to create.
3 properties 1 required
CustomFieldOption
object
Details of a custom option for a field.
2 properties
BulkCustomFieldOptionUpdateRequest
object
Details of the options to update for a custom field.
1 property
SimpleErrorCollection
object
3 properties
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

jira-issue-custom-field-options-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 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.