---
schema: rendered-html/v1
title: "Search Suggestions | Developer Portal for YouTrack and Hub Documentation"
source_url: https://www.jetbrains.com/help/youtrack/devportal/resource-api-search-assist.html
generated_at: 2026-06-11T15:13:45.100929+00:00
---

Feedback

Thanks for your feedback!

Was this page helpful?

YesNo

Developer Portal for YouTrack and Hub

- Developer Portal
- Apps
- MCP Tools
- YouTrack Workflows
- YouTrack Import Scripts
- YouTrack Form API
- YouTrack REST API
- Get Started with REST API
- REST API Reference
- Entities
- Resources
- Activity Items
- Issue Activities Page
- Build Bundles
- Enum Bundles
- Owned Bundles
- State Bundles
- User Bundles
- Version Bundles
- Custom Fields
- Field Types
- Backup Files
- Database Backup Settings
- Global Settings
- Organizations
- Projects
- Telemetry data
- Global Time Tracking Settings
- Agiles
- Articles
- Assigned Roles
- Commands
- Command Suggestions
- User Groups
- Issue Link Types
- Issue Tag
- [Issues](jetbrains__com__help__youtrack__devportal__resource-api-issues.md)
- [Issue Count](jetbrains__com__help__youtrack__devportal__resource-api-issuesgetter-count.md)
- [Permissions](jetbrains__com__help__youtrack__devportal__resource-api-permissions.md)
- [Roles](jetbrains__com__help__youtrack__devportal__resource-api-roles.md)
- [Saved Queries](jetbrains__com__help__youtrack__devportal__resource-api-savedqueries.md)
- [Search Suggestions](resource-api-search-assist.html)
- [Tags](jetbrains__com__help__youtrack__devportal__resource-api-tags.md)
- Users
- [My User Profile](jetbrains__com__help__youtrack__devportal__resource-api-users-me.md)
- Issue Work Items
- REST API Use Cases
- REST API Troubleshooting
- Color Indices List
- Hub REST API

1. YouTrack REST API
2. REST API Reference
3. Resources
4. [Search Suggestions](#0)

# Search Suggestions﻿

Last modified: 24 March 2026

Lets you get suggestions for the currently entered search query.

| Resource | ``` /api/search/assist ``` |
| --- | --- |
| Returned entity | SearchSuggestions. For the description of the entity attributes, see [Supported Fields](/help/youtrack/devportal/resource-api-search-assist.html#SearchSuggestions-supported-fields) section. |
| Supported methods | - `POST`: [Search Suggestions](/help/youtrack/devportal/resource-api-search-assist.html#create-SearchSuggestions-method). |

## SearchSuggestions attributes﻿

Represents the list of search suggestions for the currently entered search query.

### Related Resources﻿

Below you can find the list of resources that let you work with this entity.

- Search Suggestions

### Attributes﻿

This table describes attributes of the `SearchSuggestions` entity.

- To receive an attribute in the response from the server, specify it explicitly in the `fields` request parameter.
- To update an attribute, provide it in the body of a POST request.

| Field | Type | Description |
| --- | --- | --- |
| id | String | The ID of the list of search suggestions. `Read-only`. |
| caret | Int | The current caret position. The end of the current search query by default. |
| ignoreUnresolvedSetting | Boolean | When false, the Hide unresolved issues setting is taken into account for creating search suggestions. When true, this setting is ignored. True when the currently entered search query concerns a state-type field. |
| query | String | The current search query for which the suggestions are being requested. `Can be null`. |
| suggestions | Array of Suggestions | The list of search suggestions for the currently entered search query. `Read-only`. |
| folders | Array of IssueFolders | The current search context. |

## Read Search Query Suggestions﻿

Get search query suggestions for the currently entered search query.

Required fields: `query`.

### Request syntax﻿

```
POST /api/search/assist?{fields}
```

| null | The database ID of SearchSuggestions |
| --- | --- |

### Request parameters﻿

| Parameter | Type | Description |
| --- | --- | --- |
| fields | String | A list of SearchSuggestions attributes that should be returned in the response. If no field is specified, only the `entityID` is returned. |

### Sample﻿

#### Sample request﻿

```
https://example.youtrack.cloud/api/search/assist?fields=caret,query,suggestions(caret,completionEnd,completionStart,description,group,matchingEnd,matchingStart,option)
```

#### Sample request body﻿

```
{
"query": "tag: "
}
```

#### Sample response body﻿

```
{
  "caret": 5,
  "suggestions": [
    {
      "group": null,
      "completionStart": 5,
      "completionEnd": 5,
      "matchingStart": 0,
      "matchingEnd": 0,
      "caret": 6,
      "description": "exclude value",
      "option": "-",
      "$type": "Suggestion"
    {
      "group": null,
      "completionStart": 5,
      "completionEnd": 5,
      "matchingStart": 0,
      "matchingEnd": 0,
      "caret": 29,
      "description": "tag",
      "option": "Blocked by dependency",
      "$type": "Suggestion"
    {
      "group": null,
      "completionStart": 5,
      "completionEnd": 5,
      "matchingStart": 0,
      "matchingEnd": 0,
      "caret": 14,
      "description": "empty list of tags",
      "option": "no tag",
      "$type": "Suggestion"
    {
      "group": null,
      "completionStart": 5,
      "completionEnd": 5,
      "matchingStart": 0,
      "matchingEnd": 0,
      "caret": 10,
      "description": "tag",
      "option": "Star",
      "$type": "Suggestion"
    {
      "group": null,
      "completionStart": 5,
      "completionEnd": 5,
      "matchingStart": 0,
      "matchingEnd": 0,
      "caret": 9,
      "description": "tag",
      "option": "tip",
      "$type": "Suggestion"
    {
      "group": "Recent Searches",
      "completionStart": 0,
      "completionEnd": 5,
      "matchingStart": 0,
      "matchingEnd": 5,
      "caret": 10,
      "description": " ",
      "option": "tag: Star",
      "$type": "Suggestion"
    }
  ],
  "query": "tag: ",
  "$type": "SearchSuggestions"
}
```

- [Search Suggestions](/help/youtrack/devportal/resource-api-search-assist.html)
- [SearchSuggestions attributes](/help/youtrack/devportal/resource-api-search-assist.html#SearchSuggestions-supported-fields)
- [Read Search Query Suggestions](/help/youtrack/devportal/resource-api-search-assist.html#create-SearchSuggestions-method)

Operations with Specific SavedQuery[Tags](jetbrains__com__help__youtrack__devportal__resource-api-tags.md)

- Privacy & Security
- Terms Of Use
- Trademarks
- Legal

Copyright © 2000–2026 JetBrains s.r.o.
