# Get notes for a patient

Operation ID: `connectors.healthieGetPatientNotes`

Get notes for a patient. The top-level ``notes`` GraphQL query no longer accepts a ``user_id`` filter (Healthie schema, mid-2026), so a page (default 100) is fetched and filtered client-side by the ``user_id`` still present on each Note. Walk pages via ``offset`` — there's no server-side count.

## Public method

`getPatientNotes`

Signature: `connectors.healthie.createClient(config).getPatientNotes(body)`

Return type: `Promise<HealthieNoteResponse>`

## Authentication

Classification: **AUTHENTICATED**

Schemes: `bearerAuth`

## Prerequisites

None documented.

## HTTP

`POST /connectors/healthie/get-patient-notes`

## Path parameters

None.

## Query parameters

None.

## Body parameters

| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `body` | [`HealthieGetPatientNotesRequest`](../models/HealthieGetPatientNotesRequest.md) | Yes |  |  |  | No |  |

Request model: [`HealthieGetPatientNotesRequest`](../models/HealthieGetPatientNotesRequest.md)

## Request example

```json
{
  "api_url": "https://example.com/resource",
  "mode": "sandbox",
  "offset": 1,
  "open_loop_url": "https://example.com/resource",
  "secret_key": "example-api-key",
  "shard_id": "12345",
  "user_id": "12345"
}
```

## Success responses

| Status | Shape | Content type | Description |
|---|---|---|---|
| `200` | [`HealthieGetPatientNotesResponse`](../models/HealthieGetPatientNotesResponse.md) | application/json | Successful response |

## Success response examples

### 200

```json
[
  {
    "content": "example-content",
    "created_at": "example-created-at",
    "id": "12345",
    "updated_at": "example-updated-at",
    "user_id": "12345"
  }
]
```

## Common errors

| Status | Shape | Content type | Description |
|---|---|---|---|
| `400` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | Connector validation rejected the payload, or a required field was missing or of the wrong type. |
| `401` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The HealthCloud bearer token is missing or invalid, or the vendor rejected the supplied connector credentials. |
| `500` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The connector failed unexpectedly. |
| `502` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor returned an application or transport-level failure. |
| `504` | [`StandardErrorResponse`](../models/StandardErrorResponse.md) | application/json | The vendor did not respond within the connector timeout. |

## Error examples

### 400 — Invalid request

```json
{
  "error": "Invalid request"
}
```

### 401 — Authorization required

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

### 500 — Internal error

```json
{
  "error": "Internal error"
}
```

### 502 — Upstream vendor error

```json
{
  "error": "Upstream vendor error"
}
```

### 504 — Upstream timeout

```json
{
  "error": "Upstream timeout"
}
```

## NodeJS / TypeScript implementation

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

```ts
const body = {
  "api_url": "https://example.com/resource",
  "mode": "sandbox",
  "offset": 1,
  "open_loop_url": "https://example.com/resource",
  "secret_key": "example-api-key",
  "shard_id": "12345",
  "user_id": "12345"
};

const result = await connectors.healthie.createClient(config).getPatientNotes(body);
```

## cURL

```bash
curl -X POST \
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{"api_url":"https://example.com/resource","mode":"sandbox","offset":1,"open_loop_url":"https://example.com/resource","secret_key":"example-api-key","shard_id":"12345","user_id":"12345"}' \
  'https://dev-api-connectors.health.cloud/connectors/healthie/get-patient-notes'
```

## 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.