---
title: "Get field auto complete suggestions"
method: GET
path: "/rest/api/2/jql/autocompletedata/suggestions"
tags: ["JQL"]
---

# Get field auto complete suggestions

`GET /rest/api/2/jql/autocompletedata/suggestions`

## Request

- Base URL: `https://your-domain.atlassian.net`
- URL: `https://your-domain.atlassian.net/rest/api/2/jql/autocompletedata/suggestions`
- Auth: one of:
  - HTTP basic
  - OAuth 2 (authorization code, authorization URL `https://auth.atlassian.com/authorize`, token URL `https://auth.atlassian.com/oauth/token`, scopes: `read:jira-work`)
  - none

Returns the JQL search auto complete suggestions for a field.

Suggestions can be obtained by providing:

 *  `fieldName` to get a list of all values for the field.
 *  `fieldName` and `fieldValue` to get a list of values containing the text in `fieldValue`.
 *  `fieldName` and `predicateName` to get a list of all predicate values for the field.
 *  `fieldName`, `predicateName`, and `predicateValue` to get a list of predicate values containing the text in `predicateValue`.

This operation can be accessed anonymously.

**[Permissions](#permissions) required:** None.

## Query parameters

- `fieldName` string
- `fieldValue` string
- `predicateName` string
- `predicateValue` string

## Response `200`

Returned if the request is successful.

- AutoCompleteSuggestions: The results from a JQL query.
  - `results` AutoCompleteSuggestion[]: The list of suggested item.
    - `displayName` string: The display name of a suggested item. If `fieldValue` or `predicateValue` are provided, the matching text is highlighted with the HTML bold tag.
    - `value` string: The value of a suggested item.

## Other responses

- `400`: Returned if an invalid combination of parameters is passed.
- `401`: Returned if the authentication credentials are incorrect.

---

[API](https://skmtc.dev/atlassian/apis/the-jira-cloud-platform-rest-api.md) - [All operations](https://skmtc.dev/atlassian/apis/the-jira-cloud-platform-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/atlassian/apis/the-jira-cloud-platform-rest-api/revisions/5b336c497218?raw)