---
title: "Get visible issue field options"
method: GET
path: "/rest/api/2/field/{fieldKey}/option/suggestions/search"
tags: ["Issue custom field options (apps)"]
---

# Get visible issue field options

`GET /rest/api/2/field/{fieldKey}/option/suggestions/search`

Returns a [paginated](#pagination) 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](#api-group-Issue-custom-field-options) resource.

**[Permissions](#permissions) required:** Permission to access Jira.

## Path parameters

- `fieldKey` string, required

## Query parameters

- `startAt` integer
- `maxResults` integer
- `projectId` integer

## Response `200`

Returned if the request is successful.

- PageBeanIssueFieldOption — A page of items.
  - `isLast` boolean — Whether this is the last page.
  - `maxResults` integer — The maximum number of items that could be returned.
  - `nextPage` string, uri — If there is another page of results, the URL of the next page.
  - `self` string, uri — The URL of the page.
  - `startAt` integer — The index of the first item returned.
  - `total` integer — The number of items returned.
  - `values` IssueFieldOption[] — The list of items.
    - `config` IssueFieldOptionConfiguration — Details of the projects the option is available in.
      - `attributes` string[] — DEPRECATED
      - `scope` IssueFieldOptionScopeBean
        - `global` GlobalScopeBean
          - `attributes` string[] — Defines the behavior of the option in the global context.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default.
        - `projects` integer[] — DEPRECATED
        - `projects2` ProjectScopeBean[] — Defines the projects in which the option is available and the behavior of the option within each project. Specify one object per project. The behavior of the option in a project context overrides the behavior in the global context.
          - `attributes` string[] — Defines the behavior of the option in the project.If notSelectable is set, the option cannot be set as the field's value. This is useful for archiving an option that has previously been selected but shouldn't be used anymore.If defaultValue is set, the option is selected by default.
          - `id` integer — The ID of the project that the option's behavior applies to.
    - `id` integer, required — The unique identifier for the option. This is only unique within the select field's set of options.
    - `properties` object — 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](https://developer.atlassian.com/cloud/jira/platform/modules/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.

## Other responses

- `401` — Returned if the authentication credentials are incorrect or missing.
- `404` — Returned if the field is not found or does not support options.

---

[API](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api.md) · [All operations](https://skmtc.net/atlassian/apis/the-jira-cloud-platform-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/the-jira-cloud-platform-rest-api/versions/a26541c2f8bd/schema)