---
title: "Get field reference data (POST)"
method: POST
path: "/rest/api/3/jql/autocompletedata"
tags: ["JQL"]
---

# Get field reference data (POST)

`POST /rest/api/3/jql/autocompletedata`

Returns reference data for JQL searches. This is a downloadable version of the documentation provided in [Advanced searching - fields reference](https://confluence.atlassian.com/x/gwORLQ) and [Advanced searching - functions reference](https://confluence.atlassian.com/x/hgORLQ), along with a list of JQL-reserved words. Use this information to assist with the programmatic creation of JQL queries or the validation of queries built in a custom query builder.

This operation can filter the custom fields returned by project. Invalid project IDs in `projectIds` are ignored. System fields are always returned.

It can also return the collapsed field for custom fields. Collapsed fields enable searches to be performed across all fields with the same name and of the same field type. For example, the collapsed field `Component - Component[Dropdown]` enables dropdown fields `Component - cf[10061]` and `Component - cf[10062]` to be searched simultaneously.

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

## Request body

- SearchAutoCompleteFilter — Details of how to filter and list search auto complete information.
  - `includeCollapsedFields` boolean — Include collapsed fields for fields that have non-unique names.
  - `projectIds` integer[] — List of project IDs used to filter the visible field details returned.

## Response `200`

Returned if the request is successful.

- JQLReferenceData — Lists of JQL reference data.
  - `jqlReservedWords` string[] — List of JQL query reserved words.
  - `visibleFieldNames` FieldReferenceData[] — List of fields usable in JQL queries.
    - `auto` 'true' | 'false' — Whether the field provide auto-complete suggestions.
    - `cfid` string — If the item is a custom field, the ID of the custom field.
    - `deprecated` 'true' | 'false' — Whether this field has been deprecated.
    - `deprecatedSearcherKey` string — The searcher key of the field, only passed when the field is deprecated.
    - `displayName` string — The display name contains the following: * for system fields, the field name. For example, `Summary`. * for collapsed custom fields, the field name followed by a hyphen and then the field name and field type. For example, `Component - Component[Dropdown]`. * for other custom fields, the field name followed by a hyphen and then the custom field ID. For example, `Component - cf[10061]`.
    - `operators` string[] — The valid search operators for the field.
    - `orderable` 'true' | 'false' — Whether the field can be used in a query's `ORDER BY` clause.
    - `searchable` 'true' | 'false' — Whether the content of this field can be searched.
    - `types` string[] — The data types of items in the field.
    - `value` string — The field identifier.
  - `visibleFunctionNames` FunctionReferenceData[] — List of functions usable in JQL queries.
    - `displayName` string — The display name of the function.
    - `isList` 'true' | 'false' — Whether the function can take a list of arguments.
    - `supportsListAndSingleValueOperators` 'true' | 'false' — Whether the function supports both single and list value operators.
    - `types` string[] — The data types returned by the function.
    - `value` string — The function identifier.

## Other responses

- `400` — Returned if the request is not valid.
- `401` — Returned if the authentication credentials are incorrect.

---

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