Skip to main content

Function: listNotifications()

listNotifications(client, props): Promise<{ rows: object[]; rowCount: number; }>

Lists notifications for the authenticated user.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

query​

{ pageOffset?: number; pageSize?: number; sortBy?: "status" | "createdAt"; sortDir?: "asc" | "desc"; status?: "UNREAD" | "READ"; } = listNotificationsQuerySchema

Query parameters for filtering, pagination, and sorting

query.pageOffset?​

number = ...

query.pageSize?​

number = ...

query.sortBy?​

"status" | "createdAt" = ...

query.sortDir?​

"asc" | "desc" = ...

query.status?​

"UNREAD" | "READ" = ...

Returns​

Promise<{ rows: object[]; rowCount: number; }>

Promise resolving to a paginated list of notifications

Operation Id​

list-notifications