Get Visible Issue Field Options

GET {{baseUrl}}/rest/api/3/field/:fieldKey/option/suggestions/search?startAt=0&maxResults=<integer>&projectId=<long>

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.

Request Params

KeyDatatypeRequiredDescription
startAtnumberThe index of the first item to return in a page of results (page offset).
maxResultsstringThe maximum number of items to return per page.
projectIdstringFilters the results to options that are only available in the specified project.

RESPONSES

status: OK

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