Atlassian Issue Custom Field Options API

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

Documentation GitHub OpenAPI

Operations 6

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 · Atlassian Get Custom Field Option #

Ask an LLM

“What value does a given select list option ID hold?”

“Does looking up an option by ID work for Connect app options?”

Tell an agent

Get custom field option {id}.

Show the value of select list option {id}.

GET /rest/api/3/field/{fieldId}/context/{contextId}/option List a custom field's options in a context · Atlassian Get Custom Field Options Context #

Ask an LLM

“Which dropdown options does a custom field offer in a particular context?”

“Can I exclude cascading options and see only top-level ones?”

Tell an agent

List options of field {fieldId} in context {contextId}.

List only top-level options of field {fieldId} in context {contextId} ({onlyOptions}).

POST /rest/api/3/field/{fieldId}/context/{contextId}/option Add new options to a custom select field · Atlassian Create Custom Field Options Context #

Ask an LLM

“Can I add new choices, including cascading ones, to a select field?”

“Is there a limit on how many options I can add per request?”

Tell an agent

Add options {options} to field {fieldId} in context {contextId}.

Create new dropdown choices {options} for field {fieldId} context {contextId}.

PUT /rest/api/3/field/{fieldId}/context/{contextId}/option Edit existing custom field options · Atlassian 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 can't be found?”

Tell an agent

Update options {options} of field {fieldId} in context {contextId}.

Change the existing option values of field {fieldId} context {contextId} to {options}.

PUT /rest/api/3/field/{fieldId}/context/{contextId}/option/move Reorder custom field options · Atlassian Reorder Custom Field Options Context #

Ask an LLM

“How do I move select options to the top or bottom of the list?”

“Can I place options after a specific other option?”

Tell an agent

Move options {customFieldOptionIds} of field {fieldId} context {contextId} to {position}.

Place options {customFieldOptionIds} after option {after} in field {fieldId} context {contextId}.

DELETE /rest/api/3/field/{fieldId}/context/{contextId}/option/{optionId} Delete a custom field option · Atlassian Delete Custom Field Options Context #

Ask an LLM

“Can I delete a select option that still has cascading children?”

“How do I remove a single choice from a dropdown field?”

Tell an agent destructive · confirm first

Delete option {optionId} from field {fieldId} in context {contextId}.

Remove choice {optionId} from field {fieldId} context {contextId}.

Atlassian Issue Custom Field Options API

Operations 6

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