Jira

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.

GitHub OpenAPI

Operations 7

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /rest/api/3/customFieldOption/{id} Get a custom field option by ID · Get custom field option #
Ask an LLM
“How do I look up a single select list option by its option ID?”
“Which custom field and value does an option ID belong to?”
Tell an agent
Show custom field option {id}.
Look up the value of select option {id}.
GET /rest/api/3/field/{fieldId}/context/{contextId}/option List options of a custom field context · Get custom field options (context) #
Ask an LLM
“What options are available in a select field for a given context?”
“Can I list only top-level options and skip cascading ones?”
Tell an agent
List options for field {fieldId} in context {contextId}.
Show options of field {fieldId} context {contextId} with onlyOptions {onlyOptions}.
POST /rest/api/3/field/{fieldId}/context/{contextId}/option Add options to a select field context · Create custom field options (context) #
Ask an LLM
“How do I add new choices to a dropdown custom field?”
“Can I create cascading options too?”
Tell an agent
Add options {options} to field {fieldId} in context {contextId}.
Create new dropdown choices for field {fieldId}, context {contextId}.
PUT /rest/api/3/field/{fieldId}/context/{contextId}/option Update select options in a field context · Update custom field options (context) #
Ask an LLM
“How do I rename or disable existing options in a select field?”
“What happens if one of the options I update isn't found?”
Tell an agent
Update options {options} on field {fieldId} context {contextId}.
Rename existing select options in field {fieldId}, context {contextId}.
PUT /rest/api/3/field/{fieldId}/context/{contextId}/option/move Reorder options in a field context · Reorder custom field options (context) #
Ask an LLM
“How do I change the order options appear in a select field?”
“Can I move options to the first or last position?”
Tell an agent
Move options {customFieldOptionIds} to {position} in field {fieldId} context {contextId}.
Place options {customFieldOptionIds} after {after} in field {fieldId} context {contextId}.
DELETE /rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId} Delete a select option from a field context · Delete custom field options (context) #
Ask an LLM
“How do I remove a choice from a dropdown custom field?”
“Can I delete an option that still has cascading options?”
Tell an agent destructive · confirm first
Delete option {optionId} from field {fieldId} context {contextId}.
Remove choice {optionId} in field {fieldId}, context {contextId}.
DELETE /rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId}/issue Replace an option's value on issues · Replace custom field options #
Ask an LLM
“How do I swap one select option for another on all issues that use it?”
“Can I limit which issues get the replacement option with JQL?”
Tell an agent destructive · confirm first
Replace option {optionId} with {replaceWith} on issues for field {fieldId} context {contextId}.
Swap option {optionId} in field {fieldId} context {contextId} on issues matching {jql}.

Documentation

📖
Documentation
https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/
📖
Authentication
https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/#authentication
📖
Documentation
https://developer.atlassian.com/cloud/jira/software/rest/intro/
📖
Documentation
https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/
📖
APIReference
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-issue-custom-field-options-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/jira:jira-issue-custom-field-options-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

jira-issue-custom-field-options-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: ecosystem@atlassian.com
  description: Jira Cloud platform REST API documentation
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://developer.atlassian.com/platform/marketplace/atlassian-developer-terms/
  title: Jira Cloud platform REST Issue custom field options API
  version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
servers:
- url: https://your-domain.atlassian.net
tags:


# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/jira/refs/heads/main/openapi/jira-issue-custom-field-options-api-openapi.yml