[PERS SDK - v2.3.26](/sdk-reference/readme) / [Exports](/sdk-reference/modules) / NotificationApi

# Class: NotificationApi

Notification API - Low-level API client for the notification inbox

Backend routes (`src/notification/infrastructure/notifications.controller.ts`):

- `GET /notifications/channel-id` - Besu channelId for real-time WS binding
- `GET /notifications` - paginated inbox
- `GET /notifications/unread-count` - unread badge count
- `PATCH /notifications/:id/read` - mark as read
- `DELETE /notifications/:id` - delete
- `POST /notifications/send` - direct push (BUSINESS → USER, TENANT → USER|BUSINESS)


Use NotificationService or NotificationManager for higher-level operations

## Table of contents

### Constructors

- [constructor](/sdk-reference/classes/notificationapi#constructor)


### Methods

- [getChannelId](/sdk-reference/classes/notificationapi#getchannelid)
- [list](/sdk-reference/classes/notificationapi#list)
- [getUnreadCount](/sdk-reference/classes/notificationapi#getunreadcount)
- [markAsRead](/sdk-reference/classes/notificationapi#markasread)
- [delete](/sdk-reference/classes/notificationapi#delete)
- [send](/sdk-reference/classes/notificationapi#send)


## Constructors

### constructor

• **new NotificationApi**(`apiClient`): [`NotificationApi`](/sdk-reference/classes/notificationapi)

#### Parameters

| Name | Type |
|  --- | --- |
| `apiClient` | [`PersApiClient`](/sdk-reference/classes/persapiclient) |


#### Returns

[`NotificationApi`](/sdk-reference/classes/notificationapi)

#### Defined in

[notification/api/notification-api.ts:26](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/notification/api/notification-api.ts#L26)

## Methods

### getChannelId

▸ **getChannelId**(): `Promise`<`null` | `string`>

Get the Besu channelId for the authenticated account (auto-provisioned on first call).
GET /notifications/channel-id

#### Returns

`Promise`<`null` | `string`>

#### Defined in

[notification/api/notification-api.ts:32](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/notification/api/notification-api.ts#L32)

### list

▸ **list**(`options?`): `Promise`<`PaginatedResponseDTO`<`NotificationDTO`>>

List the authenticated account's notification inbox (paginated).
GET /notifications

#### Parameters

| Name | Type |
|  --- | --- |
| `options?` | [`NotificationQueryOptions`](/sdk-reference/interfaces/notificationqueryoptions) |


#### Returns

`Promise`<`PaginatedResponseDTO`<`NotificationDTO`>>

#### Defined in

[notification/api/notification-api.ts:41](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/notification/api/notification-api.ts#L41)

### getUnreadCount

▸ **getUnreadCount**(): `Promise`<`NotificationUnreadCountDTO`>

Get unread notification count.
GET /notifications/unread-count

#### Returns

`Promise`<`NotificationUnreadCountDTO`>

#### Defined in

[notification/api/notification-api.ts:58](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/notification/api/notification-api.ts#L58)

### markAsRead

▸ **markAsRead**(`id`): `Promise`<`NotificationDTO`>

Mark a notification as read.
PATCH /notifications/:id/read

#### Parameters

| Name | Type |
|  --- | --- |
| `id` | `string` |


#### Returns

`Promise`<`NotificationDTO`>

#### Defined in

[notification/api/notification-api.ts:66](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/notification/api/notification-api.ts#L66)

### delete

▸ **delete**(`id`): `Promise`<`void`>

Delete a notification.
DELETE /notifications/:id

#### Parameters

| Name | Type |
|  --- | --- |
| `id` | `string` |


#### Returns

`Promise`<`void`>

#### Defined in

[notification/api/notification-api.ts:74](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/notification/api/notification-api.ts#L74)

### send

▸ **send**(`dto`): `Promise`<`NotificationDTO`>

Send a direct notification (BUSINESS → USER, or TENANT → USER|BUSINESS).
POST /notifications/send

#### Parameters

| Name | Type |
|  --- | --- |
| `dto` | `SendNotificationDTO` |


#### Returns

`Promise`<`NotificationDTO`>

#### Defined in

[notification/api/notification-api.ts:82](https://github.com/eXplorins/PERS-sdks/blob/main/packages/pers-sdk/packages/pers-sdk/src/notification/api/notification-api.ts#L82)