List geofence rows

Places module

GET/geofencesgeofences.list

A geofence used for Compass clock in. Returns a cursor page of geofence rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Requires the capability places.venue.read.
OAuth scopes: places.
Cursor-paginated: limit, cursor, fields, sort and filter apply.
Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.

Path and query parameters

geofences.list: Path and query parameters
Field	Type	Required	Description
limit	Limit	No	Page size. Default 50, maximum 200.Constraints: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any
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_])*$
sort	Sort	No	Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_](,-?[a-z_][a-z0-9_])*$
filter	Filter	No	Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Response 200: a page of Geofence

geofences.list: 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.

{
  "data": [
    {
      "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
            ]
          ]
        ]
      }
    }
  ],
  "next_cursor": null
}

Code samples

curl -X GET "$XOS_BASE_URL/geofences" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.geofences.listAll()) {
  console.log(row);
}

for row in xos.geofences.list_all():
    print(row)

xos geofences list --all