Get a site's attendance settings
/sites/{site_id}/attendance-settingsReturns the site's own methods and selfie mode (null where it uses your organisation's), its geofence and
Wi-Fi networks, and what applies there (effective).
Scope: attendance:read · Plan: Pro and Enterprise in live mode; every plan in test mode.
Send Authorization: Bearer <token> on every request. The token is one of:
| Prefix | What it is | Where it may be used |
|---|---|---|
agoo_sk_live_ | Secret key, live mode | Your servers only |
agoo_sk_test_ | Secret key, test mode | Your servers only |
agoo_pk_live_ | Publishable key, live mode | Browsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people. |
agoo_pk_test_ | Publishable key, test mode | As above, in test mode |
Admins create keys in Console → Developers → API keys and choose each key's scopes. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.
In: header
Scope: attendance:read
Path Parameters
The site's ID.
^site_[0-7][0-9a-hjkmnp-tv-z]{25}$"site_01kjpt3yw0fz0v414608h9x65s"Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/sites/site_01kjpt3yw0fz0v414608h9x65s/attendance-settings"{ "site_id": "site_01kjpt3yw0fz0v414608h9x65s", "methods": null, "selfie_mode": "required", "geofence": { "type": "circle", "latitude": 5.6037, "longitude": -0.187, "radius_m": 150 }, "wifi_networks": [ { "ssid": "RidgeMedical-Staff" }, { "bssid": "a4:2b:b0:11:22:33" } ], "effective": { "methods": [ "qr", "pin", "face", "geofence", "terminal" ], "selfie_mode": "required" }, "updated_at": "2026-09-28T10:05:00Z"}Update attendance settings PATCH
Changes methods and evidence settings, publishes notices and sets how long evidence is kept. Send only what changes. - **Switching evidence on** (`face` or `geofence` in `methods`, or a `selfie_mode` other than `off`) needs a published notice for it, now or before; otherwise `validation_failed` at `body.notices.<evidence>`. - **Notices:** each one you send becomes a new version with its `basis`, `legal_basis` (for `required`) and `text`. Employees acknowledge (or consent to) the current version. - **Data protection decisions** (notices and retention) need the Data & privacy permission, held by Owners and Admins: keys and OAuth apps get `forbidden`. - At least one method stays on, organisation-wide and at every site; PIN can be off (for example "face only"). The Wi-Fi check is for phone clock-in, so it needs `geofence`. - Methods and evidence your plan doesn't include return `plan_required`. - Switching face off deletes every enrolled face template from your kiosks. **Scope:** `attendance:manage` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.
Update a site's attendance settings PATCH
Sets the site's own methods and selfie mode (`null` to use your organisation's again), its geofence (a circle of 20 to 5,000 metres, or a polygon of 3 to 100 points) and the Wi-Fi networks that count as being there. Send only what changes. Switching evidence on at a site needs a published notice for it. **Scope:** `attendance:manage` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.