Hanzo AI
OpenapiPatrol

List site

Lists the estate.

GET /v1/patrol/site

Addresshttps://api.hanzo.ai/v1/patrol/site
MethodGET
Operationget_patrol_site
AuthAuthorization: Bearer $HANZO_API_KEY

Lists the estate. A client sees only the sites their own customer record owns, filtered from their role rather than from anything they sent.

Request

2 fields.

FieldInTypeRequiredDescription
limitqueryintegerLimit caps how many sites are returned.
statusquerystringStatus narrows the list to ok, fault, alarm or offline.

Response

StatusBodyMeaning
200patrol.patrolSiteListok
defaultproblem-detailsrefused

200 body — 27 fields.

FieldInTypeAlwaysDescription
databodypatrol.patrolSite[]Data is the matching sites, without their zones and hazards.
data[].accountbodystringAccount is the alarm-panel account number the receiving centre reports.
data[].camerasbodyinteger (int64)Cameras is how many cameras are registered here.
data[].categorybodystringCategory is what kind of premises this is.
data[].clientbodystringClient is the customer this site belongs to.
data[].contactbodystringContact is the keyholder to reach.
data[].eircodebodystringEircode is the postal code.
data[].hazardsbodystring[]Hazards is the standing warnings, present on a single-site read.
data[].keysbodybooleanKeys says whether the operation holds a key set for this site.
data[].latbodynumber (double)Lat is the site's latitude in degrees.
data[].lonbodynumber (double)Lon is the site's longitude in degrees.
data[].namebodystringName is the site's document name and the segment /v1/patrol/site/{name} addresses it by.
data[].notesbodystringNotes is the standing brief for the site.
data[].refbodyinteger (int64)Ref is the site's number in the register.
data[].riskbodyinteger (int64)Risk is the assessed risk score.
data[].sectorbodystringSector is the patrol sector the site sits in.
data[].slabodyinteger (int64)SLA is the contracted response time in minutes.
data[].statusbodystringStatus is ok, fault, alarm or offline.
data[].tierbodystringTier is the contracted service tier.
data[].townbodystringTown is the town the site is in.
data[].unitbodystringUnit is the call sign of the unit that covers the site, or empty.
data[].visitsbodyinteger (int64)Visits is how many patrol visits the contract calls for.
data[].zonesbodypatrol.patrolZone[]Zones is the panel's detection zones, present on a single-site read.
data[].zones[].devicebodystringDevice is the detector type.
data[].zones[].locationbodystringLocation is where in the building the zone is.
data[].zones[].refbodystringRef is the zone number the panel reports.
data[].zones[].statebodystringState is the zone's last known condition.

Failure carries the platform error shape — see Errors.

Examples

hanzo patrol site list

Patrol API · All Hanzo APIs · Interactive reference

How is this guide?

On this page