<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@workgrid/client](./client.md) &gt; [Client](./client.client.md) &gt; [customQuery](./client.client.customquery.md)

## Client.customQuery() method

> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
> 

Invoke a custom query (should be used sparingly and never in production)

<b>Signature:</b>

```typescript
customQuery<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData>(queryKey: CustomQueryKey, options?: QueryOptions<TQueryFnData, TError, TData>): Promise<TData>;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  queryKey | CustomQueryKey | A unique cache key |
|  options | QueryOptions&lt;TQueryFnData, TError, TData&gt; | Any additional query options |

<b>Returns:</b>

Promise&lt;TData&gt;

The query result

