GeofenceListResponse

Schema for geofence list response

geofences object[]required

Array [

idId (string)required

nameName (string)required

description objectrequired

anyOf

• string
• null

string

geometry objectrequired

GeoJSON geometry (Polygon, MultiPolygon, or Circle)

anyOf

• GeoJSONPolygon
• GeoJSONMultiPolygon
• GeoJSONCircle

typeType (string)required

Possible values: Value must match regular expression ^Polygon$

coordinatesarray[]required

geometry_typeGeometry Type (string)required

Logical geometry type: Polygon, MultiPolygon, or Circle

Possible values: [Polygon, MultiPolygon, Circle]

radius_meters object

Circle radius in meters (only for Circle type)

anyOf

• number
• null

number

webhook_url objectrequired

anyOf

• string
• null

string

webhook_eventsstring[]required

metadata objectrequired

property name*any

is_activeIs Active (boolean)required

group_id objectrequired

anyOf

• string
• null

string

group_name objectrequired

anyOf

• string
• null

string

source object

How this geofence was created: 'draw' (manual), 'address' (geocoded), or 'building' (footprint upgrade).

anyOf

• string
• null

string

Possible values: [draw, address, building]

address object

Raw address as entered by the user (address-source only).

anyOf

• string
• null

string

buffer_meters object

Buffer radius in meters used to generate the polygon (address-source only).

anyOf

• integer
• null

integer

archivedArchived (boolean)

Whether the geofence is archived (hidden from default list and map).

Default value: false

point object

[longitude, latitude] of the geocoded address point (address-source only).

anyOf

• number[]
• null

Array [

number

]

tagsstring[]

Names of tags attached to this geofence (case as originally entered).

source_id object

Building identifier from the geometry source (building-source only).

anyOf

• string
• null

string

pre_upgrade_geometry object

GeoJSON snapshot of geometry before building-footprint upgrade (building-source only).

anyOf

• object
• null

object

building_provenance object

Versioned provenance metadata from the building geometry source (building-source only).

anyOf

• object
• null

object

created_atstring<date-time>required

updated_atstring<date-time>required

]

countCount (integer)required

total_countTotal Count (integer)required

GeofenceListResponse

{
  "geofences": [
    {
      "created_at": "2025-10-01T12:00:00Z",
      "description": "Primary loading dock perimeter",
      "geometry": {
        "coordinates": [
          [
            [
              -74.006,
              40.7128
            ],
            [
              -74.006,
              40.7138
            ],
            [
              -74.005,
              40.7138
            ],
            [
              -74.005,
              40.7128
            ],
            [
              -74.006,
              40.7128
            ]
          ]
        ],
        "type": "Polygon"
      },
      "geometry_type": "Polygon",
      "group_id": "g1h2i3j4-k5l6-7890-mnop-qr1234567890",
      "group_name": "NYC Warehouses",
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "is_active": true,
      "metadata": {
        "zone_type": "loading_dock"
      },
      "name": "Warehouse Zone A",
      "radius_meters": null,
      "updated_at": "2025-10-01T12:00:00Z",
      "webhook_events": [
        "enter",
        "exit"
      ],
      "webhook_url": "https://example.com/webhooks/geofence-events"
    }
  ],
  "count": 0,
  "total_count": 0
}