List tour

GET /v1/patrol/tour

Patrol → · All API references → · Get started →


Address	`https://api.hanzo.ai/v1/patrol/tour`
Method	`GET`
Operation	`get_patrol_tour`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Lists patrol rounds with their checkpoints — the proof-of-presence record. ?date=today narrows it to the current day.

Request

1 field.

Field	In	Type	Required	Description
`date`	query	string	—	Date narrows the list to one day, as YYYY-MM-DD.

Response

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

200 body — 20 fields.

Field	In	Type	Always	Description
`data`	body	patrol.patrolTour[]	—	Data is the matching rounds, each with its checkpoints.
`data[].date`	body	string	—	Date is the day the round belongs to.
`data[].end`	body	string	—	End is when it finished.
`data[].name`	body	string	—	Name is the tour's document name.
`data[].points`	body	patrol.patrolCheckpoint[]	—	Points is the round's checkpoints in store order.
`data[].points[].actor`	body	string	—	Actor is who confirmed it.
`data[].points[].at`	body	string	—	At is when it was confirmed, or empty.
`data[].points[].close`	body	string	—	Close is when that window shuts.
`data[].points[].lat`	body	number (double)	—	Lat is the latitude the confirmation was taken at.
`data[].points[].lon`	body	number (double)	—	Lon is the longitude the confirmation was taken at.
`data[].points[].method`	body	string	—	Method is how it was confirmed: tag, scan, fence, manual or photo.
`data[].points[].name`	body	string	—	Name is the checkpoint's document name and the segment /v1/patrol/point/{name}/confirm addresses it by.
`data[].points[].open`	body	string	—	Open is when the window to confirm it opens.
`data[].points[].photo`	body	string	—	Photo is the object key of the photo taken, or empty.
`data[].points[].site`	body	string	—	Site is the site to attend.
`data[].points[].state`	body	string	—	State is pending, done, late or skipped.
`data[].points[].tag`	body	string	—	Tag is the tag or marker to read there.
`data[].points[].tour`	body	string	—	Tour is the round this checkpoint belongs to.
`data[].start`	body	string	—	Start is when the round began.
`data[].unit`	body	string	—	Unit is the call sign running the round.

Failure carries the platform error shape — see Errors.

Examples

hanzo patrol tour

import { Configuration, PatrolApi } from 'hanzoai';

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

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_tour()

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

resp, _, err := client.PatrolAPI.GetPatrolTour(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_tour(&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).getPatrolTour();

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/tour \
  -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.

Patrol API · All Hanzo APIs · Interactive reference

Request

Response

Examples

On this page