Geofences
Circular geographic zone linked to a site or customer branch for enter and exit tracking.
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Name | label | Text | Yes | |
| Branch | customerbranchId | Reference | ||
| Latitude | latitude | Decimal | Yes | Degrees north of the equator, from -90 to 90. |
| Longitude | longitude | Decimal | Yes | Degrees east of Greenwich, from -180 to 180. |
| Radius (m) | radiusMeters | Whole Number | Yes | Metres from the anchor. Greater than zero. |
| Tags | tagIds | Tags | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
| Field | Points to | Kind |
|---|---|---|
Branch customerbranchId | Customer branches | reference |
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event logisticsgeofences.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new geofence. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this geofence. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this geofence. It stays visible and can still appear on existing documents. Unblock to edit again. | App · WebMCP · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this geofence again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this geofence from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · WebMCP · API · MCP · CLI |
| Restore | unarchive | Return this geofence to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this geofence and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |