v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
geofence_Device State

Get devices for a geofence

Returns a paginated list of devices and their states within a specific geofence. Supports filtering by inside/outside status and blueprint version ID.

get/geofence/v1/geofences/{geofence_id}/devices

Path parameters

geofence_idstring uuid required

UUID of the geofence

Query parameters

offsetinteger

Number of items to skip before starting to collect the result set

limitinteger

Maximum number of items to return

insideboolean

Filter devices by whether they are inside (true) or outside (false) the geofence

blueprint_idstring uuid

Filter devices by blueprint ID

blueprint_version_numberinteger

Filter devices by blueprint version number

Headers

X-Esper-Tenant-Idstring uuid required

Esper tenant ID associated with the request

X-Caller-Idstring required

Unique identifier for the caller

Response

Device list retrieved successfully

Example response

{
  "content": {
    "next": "/v1/geofences/f5316a75-f186-4769-970e-28d6a1a0e110/devices?offset=10&limit=10",
    "results": [
      {
        "device_id": "660e8400-e29b-41d4-a716-446655440000",
        "blueprint_id": "550e8400-e29b-41d4-a716-446655440000",
        "blueprint_version_number": 1,
        "inside": true,
        "state_changed_at": "2025-07-24T09:00:00Z",
        "latitude": 37.7749,
        "longitude": -122.4194,
        "location_updated_at": "2025-07-24T09:05:00Z"
      }
    ]
  }
}