# List notifications

Operation ID: `patient.listNotifications`

Return all FHIR Communication notifications for the authenticated patient. Requires a patient Bearer JWT.

## Public method

`listNotifications`

Signature: `patient.listNotifications()`

Return type: `Promise<JsonValue>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`GET /patients/notifications`

## Path parameters

None.

## Query parameters

None.

## Body parameters

None.

Request model: None.

## Request example

None declared in canonical OpenAPI.

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `200` | [`ListNotificationsResponse`](../models/ListNotificationsResponse.md) | application/json | List the authenticated patient's notifications |

## Success response examples

### 200

```json
{
  "notifications": [
    {
      "createdAt": "2026-08-10T23:36:51Z",
      "description": "Synthetic notification example",
      "icon": "info",
      "id": "notification-example-001",
      "read": false,
      "severity": "info",
      "title": "Test notification"
    }
  ],
  "patient_id": "patient-example-001"
}
```

## Common errors

| Status | Shape | Content type | Description |
|---|---|---|---|
| `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing, invalid, expired, or non-patient Bearer JWT |
| `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The authenticated patient has no FHIR Patient record |

## Error examples

### 401 — Missing or invalid access token

```json
{
  "error": "Authorization required"
}
```

### 404 — Patient not found

```json
{
  "error": "Patient not found"
}
```

## NodeJS / TypeScript implementation

```ts
import { HCSDK } from "@healthcloudai/hc-sdk";
```

```ts
const result = await patient.listNotifications();
```

## cURL

```bash
curl -X GET \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  'https://dev-api-patient.health.cloud/patients/notifications'
```

## Notes

None.

## Prepared Test Console scenario

No canonical scenario is currently associated.

## Real response

No approved real integration response is currently published. Unapproved candidates are never rendered as examples.