Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
esper_cloud_api_Geofence

Get geofence information

⚠️ Legacy endpoint. Geofence configuration is now managed through blueprints. Use the blueprints endpoints (/api/v2/blueprints/) to create and manage geofences going forward.

Retrieves the full details of a single geofence by its UUID.Returns the complete Geofence object including coordinates, radius, configured device actions, device count, and audit timestamps; useful during migration to read the exact parameters of a legacy geofence before recreating it in a blueprint.

About Get Geofence (Legacy)

This endpoint fetches a single legacy geofence record by geofence_id. Geofences in this legacy system were standalone entities associated with an enterprise and optionally applied to individual devices. The current approach embeds geofence definitions within blueprints via /api/v2/blueprints/, enabling consistent application across device groups rather than per-device assignment.

get/v0/enterprise/{enterprise_id}/geofence/{geofence_id}/

Path parameters

geofence_idstring uuid required

A UUID string identifying the geofence.

enterprise_idstring uuid required

A UUID string identifying the enterprise.

Response

successful operation

idstring uuid

id of the geofence

namestring required

Name of the geofence

descriptionstring

A description about the geofence

enterprisestring uuid

id of the enterprise resource

latitudestring decimal required

Latitude corresponding to the geofence

longitudestring decimal required

Longitude corresponding to the geofence

radiusinteger

The radius within which the geofence should be applied

radius_unit'KILOMETERS' | 'METERS' | 'MILES'

The unit in which the radius is taken, eg - kilometers, meters etc

device_actionsstring[]

The actions to be performed on the device

device_countinteger

Number of devices

created_bystring

The user who created the geofence

created_onstring date-time

Date and time of when the geofence was created

updated_onstring date-time

Date and time of when the geofence was updated