---
title: Notifications
path: reference/api/notifications
status: published
---

# Notifications

**3 endpoints** in this group. All paths are prefixed with `/api/v1`.

## Endpoints in this group

- [`GET /api/v1/notifications`](#get-api-v1-notifications) — List Notifications
- [`POST /api/v1/notifications/read-all`](#post-api-v1-notifications-read-all) — Mark All Notifications Read
- [`POST /api/v1/notifications/{notification_id}/read`](#post-api-v1-notifications-notification-id-read) — Mark Notification Read

---

### GET `/api/v1/notifications` — List Notifications {#get-api-v1-notifications}

List notifications for the authenticated tenant/user.

Returns notifications targeted at the specific user or at the entire
tenant (user_id is NULL).

**Parameters**:

- `page` (query, integer, optional)
- `page_size` (query, integer, optional)
- `unread_only` (query, boolean, optional)
- `category` (query, string, optional)
- `authorization` (header, string, optional)


**Responses**:

- `200` — Successful Response. Returns: `PaginatedResponse_NotificationResponse_` — {`data`, `pagination`, `meta`}
- `422` — Validation Error. Returns: `HTTPValidationError` — {`detail`}


### POST `/api/v1/notifications/read-all` — Mark All Notifications Read {#post-api-v1-notifications-read-all}

Mark all unread notifications as read for the authenticated user.

**Parameters**:

- `authorization` (header, string, optional)


**Responses**:

- `200` — Successful Response. Returns: `ApiResponse_dict_` — {`data`, `meta`}
- `422` — Validation Error. Returns: `HTTPValidationError` — {`detail`}


### POST `/api/v1/notifications/{notification_id}/read` — Mark Notification Read {#post-api-v1-notifications-notification-id-read}

Mark a single notification as read.

**Parameters**:

- `notification_id` (path, string, required)
- `authorization` (header, string, optional)


**Responses**:

- `200` — Successful Response. Returns: `ApiResponse_NotificationResponse_` — {`data`, `meta`}
- `422` — Validation Error. Returns: `HTTPValidationError` — {`detail`}