Get visible issue field options

Returns a paginated list of options for a select list issue field that can be viewed by the user.

Note that this operation only works for issue field select list options added by Connect apps, it cannot be used with issue field select list options created in Jira or using operations from the Issue custom field options resource.

Permissions required: Permission to access Jira.

{ "self": "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=0&maxResults=1", "nextPage": "https://your-domain.atlassian.net/rest/api/3/field/fieldKey/option/suggestions?startAt=1&maxResults=1", "maxResults": 1, "startAt": 0, "total": 10, "isLast": false, "values": [ { "id": 1, "value": "Team 1", "properties": { "leader": { "name": "Leader Name", "email": "lname@example.com" }, "members": 42, "description": "The team's description", "founded": "2016-06-06" } } ] }

Request

Path Params

fieldKey

string

required

The field key is specified in the following format: $(a pp - k ey)__$ (field-key). For example, example-add-on__example-issue-field. To determine the fieldKey value, do one of the following:

open the app's plugin descriptor, then app-key is the key at the top and field-key is the key in the jiraIssueFields module. app-key can also be found in the app listing in the Atlassian Universal Plugin Manager.

run Get fields and in the field details the value is returned in key. For example, "key": "teams-add-on__team-issue-field"

Query Params

startAt

integer

optional

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

maxResults

integer

optional

The maximum number of items to return per page.

projectId

integer

optional

Filters the results to options that are only available in the specified project.

Responses

🟢200Returned if the request is successful.

application/json

Body

A page of items.

isLast

boolean

read-onlyoptional

Whether this is the last page.

maxResults

integer <int32>

read-onlyoptional

The maximum number of items that could be returned.

string <uri>

read-onlyoptional

If there is another page of results, the URL of the next page.

self

string <uri>

read-onlyoptional

The URL of the page.

startAt

integer <int64>

read-onlyoptional

The index of the first item returned.

total

integer <int64>

read-onlyoptional

The number of items returned.

values

array[object (IssueFieldOption) {4}]

read-onlyoptional

The list of items.

config

object (IssueFieldOptionConfiguration)

optional

Details of the projects the option is available in.

integer <int64>

required

The unique identifier for the option. This is only unique within the select field's set of options.

properties

object

optional

The properties of the object, as arbitrary key-value pairs. These properties can be searched using JQL, if the extractions (see Issue Field Option Property Index) are defined in the descriptor for the issue field module.

value

string

required

The option's name, which is displayed in Jira.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠404Returned if the field is not found or does not support options.