v4

latestOpenAPI 3.0.1Apache 2.02026-08-016169702.3 MB
Issue custom field options (apps)

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.

get/rest/api/3/field/{fieldKey}/option/suggestions/search

Path parameters

fieldKeystring required

The field key is specified in the following format: $(app-key)__$(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 parameters

startAtinteger

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

maxResultsinteger

The maximum number of items to return per page.

projectIdinteger

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

Response

Returned if the request is successful.

isLastboolean

Whether this is the last page.

maxResultsinteger

The maximum number of items that could be returned.

nextPagestring uri

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

selfstring uri

The URL of the page.

startAtinteger

The index of the first item returned.

totalinteger

The number of items returned.