Hanzo AIDocs
Sign inAPI key

List tour

Lists patrol rounds with their checkpoints — the proof-of-presence record.

GET /v1/patrol/tour

Patrol → · All API references → · Get started →

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

FieldInTypeRequiredDescription
datequerystring—Date narrows the list to one day, as YYYY-MM-DD.

Response

StatusBodyMeaning
200patrol.patrolTourListok
defaultproblem-detailsrefused

200 body — 20 fields.

FieldInTypeAlwaysDescription
databodypatrol.patrolTour[]—Data is the matching rounds, each with its checkpoints.
data[].datebodystring—Date is the day the round belongs to.
data[].endbodystring—End is when it finished.
data[].namebodystring—Name is the tour's document name.
data[].pointsbodypatrol.patrolCheckpoint[]—Points is the round's checkpoints in store order.
data[].points[].actorbodystring—Actor is who confirmed it.
data[].points[].atbodystring—At is when it was confirmed, or empty.
data[].points[].closebodystring—Close is when that window shuts.
data[].points[].latbodynumber (double)—Lat is the latitude the confirmation was taken at.
data[].points[].lonbodynumber (double)—Lon is the longitude the confirmation was taken at.
data[].points[].methodbodystring—Method is how it was confirmed: tag, scan, fence, manual or photo.
data[].points[].namebodystring—Name is the checkpoint's document name and the segment /v1/patrol/point/{name}/confirm addresses it by.
data[].points[].openbodystring—Open is when the window to confirm it opens.
data[].points[].photobodystring—Photo is the object key of the photo taken, or empty.
data[].points[].sitebodystring—Site is the site to attend.
data[].points[].statebodystring—State is pending, done, late or skipped.
data[].points[].tagbodystring—Tag is the tag or marker to read there.
data[].points[].tourbodystring—Tour is the round this checkpoint belongs to.
data[].startbodystring—Start is when the round began.
data[].unitbodystring—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();
curl https://api.hanzo.ai/v1/patrol/tour \
  -H "Authorization: Bearer $HANZO_API_KEY"

Tool patrol, op get_patrol_tour — 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_tour",
           "input": {}
         }
       }
     }'

Patrol API · All Hanzo APIs · Interactive reference

Was this page useful?
PreviousGet tenantNextList near