> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# INotificationChannelsQuery

- Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md)
- Kind: interface
- Stability: beta
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-backend-spi/src/organization/notificationChannels/query.ts

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Service to query notification channels.

**Signature:**

```typescript
export interface INotificationChannelsQuery 
```

## Methods

| Method | Description |
| --- | --- |
| [query()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationchannelsquery/index.md#inotificationchannelsqueryquery) | **_(BETA)_** Starts the notification channels query. |
| [queryAll()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationchannelsquery/index.md#inotificationchannelsqueryqueryall) | **_(BETA)_** Starts the notification channels query. |
| [queryAllIdentifiers()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationchannelsquery/index.md#inotificationchannelsqueryqueryallidentifiers) | **_(BETA)_** Starts the notification channel identifiers query (lightweight, no sensitive data). |
| [queryIdentifiers()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationchannelsquery/index.md#inotificationchannelsqueryqueryidentifiers) | **_(BETA)_** Starts the notification channel identifiers query (lightweight, no sensitive data). |
| [withPage(page)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationchannelsquery/index.md#inotificationchannelsquerywithpage) | **_(BETA)_** Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0 |
| [withSize(size)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationchannelsquery/index.md#inotificationchannelsquerywithsize) | **_(BETA)_** Sets number of notification channels to return per page. Default size: 100 |
| [withSorting(sort)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationchannelsquery/index.md#inotificationchannelsquerywithsorting) | **_(BETA)_** Sets sorting for the query. |
| [withTypes(type)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationchannelsquery/index.md#inotificationchannelsquerywithtypes) | **_(BETA)_** Sets type of the automation for the query. |

## Method details

### INotificationChannelsQuery.query()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Starts the notification channels query.

**Signature:**

```typescript
query(): Promise<INotificationChannelsQueryResult>;
```
**Returns:**

Promise&lt;[INotificationChannelsQueryResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationchannelsqueryresult/index.md)&gt;

promise of first page of the results

### INotificationChannelsQuery.queryAll()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Starts the notification channels query.

**Signature:**

```typescript
queryAll(): Promise<INotificationChannelMetadataObject[]>;
```
**Returns:**

Promise&lt;[INotificationChannelMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.inotificationchannelmetadataobject/index.md)[]&gt;

promise with a list of all notification channels matching the specified options

### INotificationChannelsQuery.queryAllIdentifiers()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Starts the notification channel identifiers query (lightweight, no sensitive data).

**Signature:**

```typescript
queryAllIdentifiers(): Promise<INotificationChannelIdentifier[]>;
```
**Returns:**

Promise&lt;[INotificationChannelIdentifier](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.inotificationchannelidentifier/index.md)[]&gt;

promise with a list of all notification channel identifiers matching the specified options

### INotificationChannelsQuery.queryIdentifiers()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Starts the notification channel identifiers query (lightweight, no sensitive data).

**Signature:**

```typescript
queryIdentifiers(): Promise<INotificationChannelIdentifiersQueryResult>;
```
**Returns:**

Promise&lt;[INotificationChannelIdentifiersQueryResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationchannelidentifiersqueryresult/index.md)&gt;

promise of first page of the results

### INotificationChannelsQuery.withPage()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0

**Signature:**

```typescript
withPage(page: number): INotificationChannelsQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| page | number | zero indexed, must be non-negative |

**Returns:**

[INotificationChannelsQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationchannelsquery/index.md)

notification channels query

### INotificationChannelsQuery.withSize()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Sets number of notification channels to return per page. Default size: 100

**Signature:**

```typescript
withSize(size: number): INotificationChannelsQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| size | number | desired max number of notification channels per page must be a positive number |

**Returns:**

[INotificationChannelsQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationchannelsquery/index.md)

notification channels query

### INotificationChannelsQuery.withSorting()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Sets sorting for the query.

**Signature:**

```typescript
withSorting(sort: string[]): INotificationChannelsQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| sort | string[] | Sorting criteria in the format: property,(asc\|desc). Default sort order is ascending. Multiple sort criteria are supported. |

**Returns:**

[INotificationChannelsQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationchannelsquery/index.md)

notification channels query

### INotificationChannelsQuery.withTypes()

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Sets type of the automation for the query.

**Signature:**

```typescript
withTypes(type: NotificationChannelDestinationType[]): INotificationChannelsQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| type | [NotificationChannelDestinationType](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.notificationchanneldestinationtype/index.md)[] | type of the automation, e.g. "schedule" or "trigger" |

**Returns:**

[INotificationChannelsQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationchannelsquery/index.md)

notification channels query