# List note

URL: https://docs.hanzo.ai/docs/openapi/patrol/get-patrol-note

> Lists internal remarks.

`GET /v1/patrol/note`

> [Patrol →](https://docs.hanzo.ai/docs/openapi/patrol) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                        |
| ------------- | -------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/patrol/note`  |
| **Method**    | `GET`                                  |
| **Operation** | `get_patrol_note`                      |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY` |

Lists internal remarks. The client never reaches them: patrol.note is
its own DocType and its permissions do not name the client, so there is no
note row for a customer to read.

## Request

1 field.

| Field     | In    | Type   | Required | Description                                             |
| --------- | ----- | ------ | -------- | ------------------------------------------------------- |
| `subject` | query | string | —        | Subject narrows the list to one subject by exact match. |

## Response

| Status    | Body                  | Meaning |
| --------- | --------------------- | ------- |
| `200`     | patrol.patrolNoteList | ok      |
| `default` | problem-details       | refused |

`200` body — 6 fields.

| Field            | In   | Type                 | Always | Description                                |
| ---------------- | ---- | -------------------- | ------ | ------------------------------------------ |
| `data`           | body | patrol.patrolNote\[] | —      | Data is the matching notes in store order. |
| `data[].actor`   | body | string               | —      | Actor is who wrote it.                     |
| `data[].at`      | body | string               | —      | At is when it was written.                 |
| `data[].body`    | body | string               | —      | Body is the remark.                        |
| `data[].name`    | body | string               | —      | Name is the note's document name.          |
| `data[].subject` | body | string               | —      | Subject is what the note is about.         |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo patrol note get
```

**SDK**

**.ts**

```ts
import { Configuration, PatrolApi } from 'hanzoai';

const api = new PatrolApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPatrolNote();
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import PatrolApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = PatrolApi(client).get_patrol_note()
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.PatrolAPI.GetPatrolNote(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, patrol_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = patrol_api::get_patrol_note(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.PatrolApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new PatrolApi(client).getPatrolNote();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/patrol/note \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

Tool `patrol`, op `get_patrol_note` — POST the JSON-RPC envelope to `https://api.hanzo.ai/v1/mcp`.

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "patrol",
         "arguments": {
           "op": "get_patrol_note",
           "input": {}
         }
       }
     }'
```

---

[Patrol API](https://docs.hanzo.ai/docs/openapi/patrol) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)