Jira

Jira Issue custom field options (apps) API

This resource represents custom issue field select list options created by a Connect app. See [Issue custom field options](#api-group-Issue-custom-field-options) to manipulate options created in Jira or using the REST API. A select list issue field is a type of [issue field](https://developer.atlassian.com/cloud/jira/platform/modules/issue-field/) that enables a user to select an option from a list. Use it to add, remove, and update the options of a select list issue field.

GitHub OpenAPI

Operations 8

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/field/{fieldKey}/option List all options of an app's select field · Get all issue field options #
Ask an LLM
“How do I list every option my Connect app added to its select list issue field?”
“Does the full option list work for select fields created in Jira itself?”
Tell an agent
List all options of app issue field {fieldKey}.
Show {maxResults} options of select field {fieldKey} starting at {startAt}.
POST /rest/api/3/field/{fieldKey}/option Add an option to an app's select field · Create issue field option #
Ask an LLM
“How can my Connect app add a new choice to its select list issue field?”
“Can I limit a new field option to certain projects when creating it?”
Tell an agent
Add option {value} to app issue field {fieldKey}.
Create option {value} in select field {fieldKey}, available only in {config}.
GET /rest/api/3/field/{fieldKey}/option/suggestions/edit List field options the user can select · Get selectable issue field options #
Ask an LLM
“Which options of an app select field can the current user pick when editing an issue?”
“Can I narrow selectable field options to a single project?”
Tell an agent
List options the user can select for field {fieldKey}.
Show selectable options of field {fieldKey} in project {projectId}.
GET /rest/api/3/field/{fieldKey}/option/suggestions/search List field options the user can view · Get visible issue field options #
Ask an LLM
“Which options of an app select field is the current user allowed to see, even ones they cannot select?”
“Can I list viewable field options for one project only?”
Tell an agent
List the options of field {fieldKey} the user can view.
Show visible options of select field {fieldKey} for project {projectId}.
DELETE /rest/api/3/field/{fieldKey}/option/{optionId} Delete an option from an app's select field · Delete issue field option #
Ask an LLM
“How do I remove a choice from my app's select list field?”
“Can a Connect app delete options it previously added to its field?”
Tell an agent destructive · confirm first
Delete option {optionId} from field {fieldKey}.
Remove the {optionId} choice from app select field {fieldKey}.
GET /rest/api/3/field/{fieldKey}/option/{optionId} Get one option of an app's select field · Get issue field option #
Ask an LLM
“How do I read a single option's name and properties from my app's select field?”
“Which projects is a specific field option available in?”
Tell an agent
Get option {optionId} of field {fieldKey}.
Show the configuration of option {optionId} in app field {fieldKey}.
PUT /rest/api/3/field/{fieldKey}/option/{optionId} Update or create a field option by ID · Update issue field option #
Ask an LLM
“How do I rename an existing option in my app's select field?”
“Can I create a field option with an ID I choose myself?”
Tell an agent
Rename option {optionId} of field {fieldKey} to {value}, with body id {id}.
Upsert option {optionId} named {value} in field {fieldKey}, using the same {id} in the body.
DELETE /rest/api/3/field/{fieldKey}/option/{optionId}/issue Deselect an option on issues, optionally replacing it · Replace issue field option #
Ask an LLM
“How do I swap one select option for another on every issue that uses it?”
“Can I limit the option replacement to issues matching a JQL query?”
Tell an agent destructive · confirm first
Deselect option {optionId} of field {fieldKey} on all issues and select {replaceWith} instead.
Replace option {optionId} in field {fieldKey} with {replaceWith} only 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-apps-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-apps-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-apps-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 (apps)…
  version: 1001.0.0-SNAPSHOT-82b018affa468e58f284fbe4df33536469d757df
servers:
- url: https://your-domain.atlassian.net
tags:


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