Create a geofence

Places module

POST/geofencesgeofences.create

A geofence used for Compass clock in. Creates a geofence. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability org.time_attendance.write.
OAuth scopes: org.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: GeofenceCreate

geofences.create: GeofenceCreate
Field	Type	Required	Description
name	string	Yes	Geofence name.Constraints: length 1 to 300
venue_id	string (uuid)	Yes	Identifier of the venue.
zone_id	string (uuid) \| null	No	Identifier of the zone the geofence outlines.
boundary	GeoJsonPolygon	Yes	A GeoJSON Polygon in WGS 84 (RFC 7946): rings of [longitude, latitude] positions.

{
  "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
        ]
      ]
    ]
  }
}

Response 201: Geofence

geofences.create: 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 POST "$XOS_BASE_URL/geofences" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"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]]]}}'

const { data } = await xos.geofences.create({
    "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
          ]
        ]
      ]
    }
  });

response = xos.geofences.create({"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]]]}})

xos geofences create --data '{"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]]]}}'