Own The? Customize your docs with AI search, analytics, and more.

GET

Get custom field options (context)

https://your-domain.atlassian.net/rest/api/3/field/{fieldId}/context/{contextId}/option

Returns a paginated list of all custom field option for a context. Options are returned first then cascading options, in the order they display in Jira. This operation works for custom field options created in Jira or the operations from this resource. **To work with issue field select list options created for Connect apps use the Issue custom field options (apps) operations.** **Permissions required:** *Administer Jira* global permission.

Access Token Required: API Key

Path Parameters

fieldIdstringrequired

The ID of the custom field.

contextIdintegerrequired

The ID of the context.

Query Params

optionIdinteger

The ID of the option.

onlyOptionsbooleanDefault: false

Whether only options are returned.

startAtintegerDefault: 0

The index of the first item to return in a page of results (page offset).

maxResultsintegerDefault: 100

The maximum number of items to return per page.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://your-domain.atlassian.net/rest/api/3/field/{fieldId}/context/{contextId}/option' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET