---
title: "CustomQuery"
slug: "customquery-1"
updated: 2023-05-23T18:17:34Z
published: 2023-05-23T18:17:34Z
canonical: "docs.visualvault.com/customquery-1"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.visualvault.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CustomQuery

#### **GET **/customquery****

---

> **Run and return the results of a custom query configured in VisualVault.**

##### ****Query Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| queryName | String | Name of the custom query. |
| filter | String | String containing a valid query filter. |
| value | String | Query search value. |
| offset | String | Sets an offset to the start of the search. |
| sort | String | The name of a data column to sort by. |
| sortDir | String | Sort direction. - asc: Ascending order - desc: Descending order |
| q | String | A VisualVault REST API Data Query. |
| params | String | List of query parameters. |

##### ****Response Codes****

| Code | Description |
| --- | --- |
| 400 | Bad Request |
| 404 | Not Found |

#### **GET **/customquery/{id}****

---

> **Run and return the results of a custom query configured in VisualVault by ID.**

##### ****Route Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| id* | Guid | The custom query id. |

##### ****Query Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| filter | String | String containing a valid query filter. |
| offset | String | Sets an offset to the start of the search. |
| sort | String | The name of a data column to sort by. |
| sortDir | String | Sort direction. - asc: Ascending order - desc: Descending order |
| q | String | A VisualVault REST API Data Query. |
| params | String | List of query parameters. |

##### ****Response Codes****

| Code | Description |
| --- | --- |
| 400 | Bad Request |
| 404 | Not Found |

#### **GET **/customquery/querydependency/{id}****

---

> **No Description.**

##### ****Route Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| id* | Guid | The custom query id. |

##### ****Query Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| sourceType | String | Dropdown list source type. - UserQuery - GroupQuery - VisualVaultDropDownList - CustomQuery - Image |
| hashonly | Bool | Return only a hash code. |

##### ****Response Codes****

| Code | Description |
| --- | --- |
| 400 | Bad Request |

#### **GET **/customquery/imagedependency/{id}****

---

> **No Description.**

##### ****Route Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| id* | Guid | The custom query id. |

##### ****Query Parameters****

| Parameter | Type | Description |
| --- | --- | --- |
| imageSourceType | String | Image source. - ImageLibrary - DocumentLibrary - MarketPlaceImageLibrary |

##### ****Response Codes****

| Code | Description |
| --- | --- |
| 400 | Bad Request |

#### **GET **/customquery/smalldependencies****

---

> **No Description.**

No Parameters.

##### ****Response Codes****

| Code | Description |
| --- | --- |
| 400 | Bad Request |