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

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).

Atlassian Issue Custom Field Options (Apps) API is one of 183 APIs that Atlassian publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 17 JSON Schema definitions.

Tagged areas include Issue Custom Field Options (Apps). The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 17 JSON Schemas.

This API exposes 8 operations across 5 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77.

Requests are made against a single base URL, https://your-domain.atlassian.net.

8 operations 5 paths 10 schemas 2 DELETE4 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1001.0.0-SNAPSHOT-67b5c6e5f3598d7ec1649016d026468ab2838a77
Server
https://your-domain.atlassian.net
Authentication
OAuth 2.0, HTTP Basic
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Atlassian Issue Custom Field Options (Apps) API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 183 scopes. It accepts HTTP basic authentication (basicAuth).

  • OAuth2 — OAuth2 scopes for Jira
  • basicAuth — You can access this resource via basic auth.

Paths & Operations 8

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

Issue Custom Field Options (Apps) 8
GET
/rest/api/3/field/{fieldKey}/option
Atlassian Get All Issue Field Options
atlassianGetallissuefieldoptions 3 params → 200400403
POST
/rest/api/3/field/{fieldKey}/option
Atlassian Create Issue Field Option
atlassianCreateissuefieldoption 1 param body → 200400403404
GET
/rest/api/3/field/{fieldKey}/option/suggestions/edit
Atlassian Get Selectable Issue Field Options
atlassianGetselectableissuefieldoptions 4 params → 200401404
GET
/rest/api/3/field/{fieldKey}/option/suggestions/search
Atlassian Get Visible Issue Field Options
atlassianGetvisibleissuefieldoptions 4 params → 200401404
DELETE
/rest/api/3/field/{fieldKey}/option/{optionId}
Atlassian Delete Issue Field Option
atlassianDeleteissuefieldoption 2 params → 204403404409
GET
/rest/api/3/field/{fieldKey}/option/{optionId}
Atlassian Get Issue Field Option
atlassianGetissuefieldoption 2 params → 200400403404
PUT
/rest/api/3/field/{fieldKey}/option/{optionId}
Atlassian Update Issue Field Option
atlassianUpdateissuefieldoption 2 params body → 200400403404
DELETE
/rest/api/3/field/{fieldKey}/option/{optionId}/issue
Atlassian Replace Issue Field Option
atlassianReplaceissuefieldoption 6 params → 303400403404

Schemas 10

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

ProjectScopeBean
object
2 properties
GlobalScopeBean
object
1 property
RemoveOptionFromIssuesResult
object
3 properties
SimpleErrorCollection
object
3 properties
IssueFieldOptionScopeBean
object
3 properties
IssueFieldOption
object
Details of the options for a select list issue field.
4 properties 2 required
TaskProgressBeanRemoveOptionFromIssuesResult
object
Details about a task.
13 properties 8 required
IssueFieldOptionCreateBean
object
3 properties 1 required
IssueFieldOptionConfiguration
object
Details of the projects the option is available in.
2 properties
PageBeanIssueFieldOption
object
A page of items.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

atlassian-issue-custom-field-options-apps-api-openapi.yml Raw ↑

Other APIs Atlassian publishes across the network.

Atlassian Jira Software Backlog API
Atlassian Jira Software Board API
Atlassian Jira Software Epic API
Atlassian Jira Software Sprint API
Atlassian Jira Software Development Information API
Atlassian Jira Software Feature Flags API
Atlassian Jira Software Deployments API
Atlassian Jira Software Builds API
Atlassian Jira Software Remote Links API
Atlassian Jira Software Security Information API
Atlassian Jira Service Management Customer API
Atlassian Jira Service Management Info API
Where this information came from

This is an independent, third-party profile of Atlassian Issue Custom Field Options (Apps) 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.