Get selectable issue field options

GET

/rest/api/3/field/{fieldKey}/option/suggestions/edit

Returns a paginated list of options for a select list issue field that can be viewed and selected 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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/field//option/suggestions/edit'

Response Example

200 - Success

{"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

Query Params

Responses

🟢200Returned if the request is successful.

application/json

Body

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

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

Modified at 2023-07-13 03:27:27

Create issue field option

Get visible issue field options