Skip to main content

GeofenceListResponse

Schema for geofence list response

geofences object[]required
  • Array [
  • idId (string)required
    nameName (string)required
    description objectrequired
    anyOf
    string
    geometry objectrequired

    GeoJSON geometry (Polygon, MultiPolygon, or Circle)

    property name*any

    GeoJSON geometry (Polygon, MultiPolygon, or Circle)

    geometry_typeGeometry Type (string)required

    Logical geometry type: Polygon, MultiPolygon, or Circle

    radius_meters object

    Circle radius in meters (only for Circle type)

    anyOf
    number
    webhook_url objectrequired
    anyOf
    string
    webhook_eventsstring[]required
    metadata objectrequired
    property name*any
    is_activeIs Active (boolean)required
    group_id objectrequired
    anyOf
    string
    group_name objectrequired
    anyOf
    string
    created_atstring<date-time>required
    updated_atstring<date-time>required
  • ]
  • countCount (integer)required
    GeofenceListResponse
    {
    "geofences": [
    {
    "id": "string",
    "name": "string",
    "description": "string",
    "geometry": {},
    "geometry_type": "string",
    "radius_meters": 0,
    "webhook_url": "string",
    "webhook_events": [
    "string"
    ],
    "metadata": {},
    "is_active": true,
    "group_id": "string",
    "group_name": "string",
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z"
    }
    ],
    "count": 0
    }