Hanzo AIDocs
Sign inAPI key

List unit

Lists the fleet with each unit's position trail, which is what the map draws.

GET /v1/patrol/unit

Patrol → · All API references → · Get started →

Addresshttps://api.hanzo.ai/v1/patrol/unit
MethodGET
Operationget_patrol_unit
AuthAuthorization: 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

StatusBodyMeaning
200patrol.patrolUnitListok
defaultproblem-detailsrefused

200 body — 13 fields.

FieldInTypeAlwaysDescription
databodypatrol.patrolUnit[]—Data is every unit in the org, each with its position trail.
data[].duebodystring—Due is the lone-worker deadline, or empty when none is set.
data[].latbodynumber (double)—Lat is the unit's last latitude in degrees.
data[].lonbodynumber (double)—Lon is the unit's last longitude in degrees.
data[].namebodystring—Name is the unit's call sign, which is its document name and the segment /v1/patrol/unit/{name}/fix addresses it by.
data[].officerbodystring—Officer is who is crewing it.
data[].sectorbodystring—Sector is the patrol sector it works.
data[].seenbodystring—Seen is when the unit last reported.
data[].statebodystring—State is available, assigned, enroute, onsite, offline, break or emergency.
data[].trailbodypatrol.patrolFix[]—Trail is the tail of the unit's recorded positions, oldest first.
data[].trail[].atbodystring—At is when the position was recorded.
data[].trail[].latbodynumber (double)—Lat is the latitude in degrees.
data[].trail[].lonbodynumber (double)—Lon is the longitude in degrees.

Failure carries the platform error shape — see Errors.

Examples

hanzo patrol unit list
import { 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();
curl https://api.hanzo.ai/v1/patrol/unit \
  -H "Authorization: Bearer $HANZO_API_KEY"

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

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_unit",
           "input": {}
         }
       }
     }'

Patrol API · All Hanzo APIs · Interactive reference

Was this page useful?
PreviousList nearNextCreate alarm