List unit
Lists the fleet with each unit's position trail, which is what the map draws.
GET /v1/patrol/unit
| Address | https://api.hanzo.ai/v1/patrol/unit |
| Method | GET |
| Operation | get_patrol_unit |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Lists the fleet with each unit's position trail, which is what the map draws. It is the operation's own: a unit names no site, so a customer reads none of it — the officer crewing one is the company's staff, and the trail is where that person has been all shift.
Request
GET /v1/patrol/unit takes no parameters and no body — the credential is the whole request.
Response
| Status | Body | Meaning |
|---|---|---|
200 | patrol.patrolUnitList | ok |
default | problem-details | refused |
200 body — 13 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | patrol.patrolUnit[] | — | Data is every unit in the org, each with its position trail. |
data[].due | body | string | — | Due is the lone-worker deadline, or empty when none is set. |
data[].lat | body | number (double) | — | Lat is the unit's last latitude in degrees. |
data[].lon | body | number (double) | — | Lon is the unit's last longitude in degrees. |
data[].name | body | string | — | Name is the unit's call sign, which is its document name and the segment /v1/patrol/unit/{name}/fix addresses it by. |
data[].officer | body | string | — | Officer is who is crewing it. |
data[].sector | body | string | — | Sector is the patrol sector it works. |
data[].seen | body | string | — | Seen is when the unit last reported. |
data[].state | body | string | — | State is available, assigned, enroute, onsite, offline, break or emergency. |
data[].trail | body | patrol.patrolFix[] | — | Trail is the tail of the unit's recorded positions, oldest first. |
data[].trail[].at | body | string | — | At is when the position was recorded. |
data[].trail[].lat | body | number (double) | — | Lat is the latitude in degrees. |
data[].trail[].lon | body | number (double) | — | Lon is the longitude in degrees. |
Failure carries the platform error shape — see Errors.
Examples
hanzo patrol unit listimport { Configuration, PatrolApi } from 'hanzoai';
const api = new PatrolApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPatrolUnit();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_unit()cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.PatrolAPI.GetPatrolUnit(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_unit(&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).getPatrolUnit();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/unit \
-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?