Atlassian Issue Custom Field Options (Apps) API

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

Documentation 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-list field · Atlassian Get All Issue Field Options #

Ask an LLM

“What options exist in my Connect app's select list issue field?”

“Can I page through every option of an app-defined issue field?”

Tell an agent

List all options for issue field {fieldKey}.

Page through options of app field {fieldKey} starting at {startAt}.

POST /rest/api/3/field/{fieldKey}/option Add an option to an app's select-list field · Atlassian Create Issue Field Option #

Ask an LLM

“How does my Connect app add a new choice to its select list issue field?”

“Can I attach properties to an option when creating it?”

Tell an agent

Create option {value} on issue field {fieldKey}.

Add option {value} to app field {fieldKey} with properties {properties}.

GET /rest/api/3/field/{fieldKey}/option/suggestions/edit List options a user can select when editing · Atlassian Get Selectable Issue Field Options #

Ask an LLM

“Which app field options can the current user pick when editing an issue?”

“Can I limit selectable options to those valid in one project?”

Tell an agent

List the selectable options for field {fieldKey}.

Show options of {fieldKey} I can select in project {projectId}.

GET /rest/api/3/field/{fieldKey}/option/suggestions/search List options a user can view · Atlassian Get Visible Issue Field Options #

Ask an LLM

“Which app field options is the current user allowed to see, even if not select?”

“Can I list viewable options for a field within one project?”

Tell an agent

List the visible options for field {fieldKey}.

Show options of {fieldKey} viewable in project {projectId}.

DELETE /rest/api/3/field/{fieldKey}/option/{optionId} Delete an option from an app's select-list field · Atlassian Delete Issue Field Option #

Ask an LLM

“How do I remove an option from my app's select list field?”

“Can a Connect app delete a field option it created?”

Tell an agent destructive · confirm first

Delete option {optionId} from issue field {fieldKey}.

Remove app field option {optionId} on {fieldKey}.

GET /rest/api/3/field/{fieldKey}/option/{optionId} Get one option of an app's select-list field · Atlassian Get Issue Field Option #

Ask an LLM

“How do I fetch a single app field option by id?”

“What value and config does this select list option have?”

Tell an agent

Get option {optionId} of issue field {fieldKey}.

Show me app field option {optionId} on {fieldKey}.

PUT /rest/api/3/field/{fieldKey}/option/{optionId} Update or upsert an app field option by id · Atlassian Update Issue Field Option #

Ask an LLM

“How do I change the label of an existing app field option?”

“Can I create an option with an id I choose myself?”

Tell an agent

Set option {optionId} on field {fieldKey} to value {value} with body id {id}.

Upsert option {optionId} of {fieldKey} with value {value}, matching id {id}.

DELETE /rest/api/3/field/{fieldKey}/option/{optionId}/issue Deselect an option on issues, optionally replacing it · Atlassian Replace Issue Field Option #

Ask an LLM

“How do I swap one app field option for another across all issues?”

“Can I limit an option replacement to issues matching a JQL query?”

Tell an agent destructive · confirm first

Replace option {optionId} of field {fieldKey} with {replaceWith} on all issues.

Deselect option {optionId} of {fieldKey} only on issues matching {jql}.

Atlassian Issue Custom Field Options (Apps) API

Operations 8

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification