Get a geofence

Places module

GET/geofences/{id}geofences.get

A geofence used for Compass clock in. Returns one geofence with its `ETag`. A geofence the caller may not see returns 404.

Requires the capability places.venue.read.
OAuth scopes: places.
Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

geofences.get: Path and query parameters
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the geofence.
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$

Response 200: Geofence

geofences.get: Geofence
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the geofence.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
name	string	Yes	Geofence name.Constraints: length 1 to 300
venue_id	string (uuid)	Yes	Identifier of the venue.
zone_id	string (uuid) \| null	Yes	Identifier of the zone the geofence outlines.
boundary	GeoJsonPolygon	Yes	A GeoJSON Polygon in WGS 84 (RFC 7946): rings of [longitude, latitude] positions.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "Harborfront Site",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "boundary": {
    "type": "Polygon",
    "coordinates": [
      [
        [
          -80.19,
          25.77
        ],
        [
          -80.18,
          25.77
        ],
        [
          -80.18,
          25.78
        ],
        [
          -80.19,
          25.77
        ]
      ]
    ]
  }
}

Code samples

curl -X GET "$XOS_BASE_URL/geofences/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"

const { data, etag } = await xos.geofences.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");

response = xos.geofences.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")

xos geofences get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f