# Get QueryAssist

## Request

```CURL
GET [[[<REST API URL>|Hub-Rest-Api-URL.html]]]/userdetails/queryAssist?query=string&amp;caret=int
```

|  Parameter  |  Description  |
| --- | --- |
|  `query`  |                            Optional. Lets you specify a search query to filter the returned results. See [Query Syntax](hub-api-query-syntax.html) for the definition of supported logical operations syntax. For the UserDetails, the following fields and tuples are supported:     authLogin: userAzureLogin — User details with given Azure identifier      authName: userAzureName — User with the given name provided by Azure      authLogin: userGithubLogin — User details with given GitHub login      fullName: value — User details with given name in GitHub      authLogin: value — User details with given JetBrains Account login      authLogin: userJiraLogin — User details with given login in Jira      authName: userJiraName — User details with given name in Jira      authLogin: userLdapLogin — User details with given LDAP user ID      authName: value — User details with given name in LDAP      authName: userOpenIDName — User details with given name in OpenID      has: avatar — Has avatar      openID: value — User details with given OpenID identifier      authName: userSamlName — User details with the given name provided by SAML      authLogin: value — User details with given Hub login      email: email — User details with the given email      has: email — User details with email      has: originService — User details that were imported from some service      has: authLogin — Details with login      id: value — User detail with the given ID      originService: service — User details that were imported from the given service      type: authModuleType — User details of auth modules of the given type      user: user — User details of the given user     |
|  `caret`  |                              Query parameter of type int.  |

## Response

|  Response Code  |  Meaning  |
| --- | --- |
|  200 OK  |  Successful request.  |
|  400 Bad Request  |  At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response.  |
|  403 Forbidden  |  The requester has no access to the requested resource.  |
|  404 Not Found  |  The requested resource was not found.  |
|  500 Internal Server Error  |  Failed to process request because of the server error. For details, check the error message in the response.  |

### Response body

```JSON
{
  "query": string, 
  "caret": int, 
  "styleRanges": [[[[queryStyleRange|HUB-REST-API_JSON-Scheme.html#queryStyleRange]]], ...], 
  "suggestions": [[[[querySuggestItem|HUB-REST-API_JSON-Scheme.html#querySuggestItem]]], ...]
}
```