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

# INotificationsQuery

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

Service to query notifications.

**Signature:**

```typescript
export interface INotificationsQuery 
```

## Methods

| Method | Description |
| --- | --- |
| [query()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationsquery/index.md#inotificationsqueryquery) | Starts the notifications query. |
| [queryAll()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationsquery/index.md#inotificationsqueryqueryall) | Starts the notifications query. |
| [withPage(page)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationsquery/index.md#inotificationsquerywithpage) | 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.inotificationsquery/index.md#inotificationsquerywithsize) | Sets number of notifications to return per page. Default size: 100 |
| [withStatus(status)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationsquery/index.md#inotificationsquerywithstatus) | Filter notifications by read status. |
| [withWorkspace(workspaceId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.inotificationsquery/index.md#inotificationsquerywithworkspace) | Filter notifications by workspace. |

## Method details

### INotificationsQuery.query()

Starts the notifications query.

**Signature:**

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

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

promise of first page of the results

### INotificationsQuery.queryAll()

Starts the notifications query.

**Signature:**

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

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

promise with a list of all notifications matching the specified options

### INotificationsQuery.withPage()

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): INotificationsQuery;
```

#### Parameters

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

**Returns:**

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

notifications query

### INotificationsQuery.withSize()

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

**Signature:**

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

#### Parameters

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

**Returns:**

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

notifications query

### INotificationsQuery.withStatus()

Filter notifications by read status.

**Signature:**

```typescript
withStatus(status: "read" | "unread"): INotificationsQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| status | "read" \| "unread" | "read" or "unread" |

**Returns:**

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

notifications query

### INotificationsQuery.withWorkspace()

Filter notifications by workspace.

**Signature:**

```typescript
withWorkspace(workspaceId: string): INotificationsQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| workspaceId | string | id of the workspace |

**Returns:**

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

notifications query