List note
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…
GET /v1/patrol/note
| 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.
Examples
hanzo patrol note getimport { Configuration, PatrolApi } from 'hanzoai';
const api = new PatrolApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPatrolNote();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()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
}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?;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();The method above is the one at the current release of the document. [email protected] (npm) was generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl https://api.hanzo.ai/v1/patrol/note \
-H "Authorization: Bearer $HANZO_API_KEY"MCP declares no tool for patrol — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.
How is this guide?