Get attendance settings
Returns how people may clock in across your organisation, the evidence each punch records, the current notice and basis for each evidence type, and how long selfies and coordinates are kept.
- Methods:
qr(the kiosk scans a staff QR badge),phone_badge(the kiosk scans the staff badge the Workspace app shows, which changes every 30 seconds),rotating_qr(a phone scans the kiosk's code, which changes every 30 seconds),pin,nfc,face(on a kiosk),geofence(a phone inside the site's area) andterminal(your own terminal, through the API). At least one is on; sites can change them. A method that's off isn't offered, with one exception: after a failed face match the kiosk offers a fallback (PIN, a badge, NFC or a supervisor-assisted punch, methodassisted), recordedface_check: not_verifiedfor review, so nobody is ever locked out. - Evidence (face, selfie, location) is off until you switch it on, and each type needs a published
notice. Its
basisisrequired(your organisation requires it under its legal basis; employees acknowledge the notice and capture goes ahead either way) orconsent(captured only for people who consented).
Scope: attendance:read · Plan: Pro and Enterprise in live mode; every plan in test mode.
AuthorizationBearer <token>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.
Scope: attendance:read
The attendance settings.
application/json- response
How people clock in across your organisation and what evidence punches record.
methods*array<>Methods on organisation-wide (at least one). Sites can change this.
selfie_mode*SelfieModeoff, optional or required (for QR, PIN, NFC and phone punches; never face or terminal punches).
"off""optional""required"location_evidence*stringWith phone clock-in (geofence): keep the location check's result only, or the coordinates too.
"result""coordinates"wifi_check*booleanPhone punches may pass by a site Wi-Fi network instead of GPS.
wifi_identifiers*booleanKeep the network's SSID and BSSID on the punch.
face_fallback_approval*booleanA fallback after a failed face match needs a supervisor's approval at the kiosk.
shift_reminder_minutes*integerRemind people on the Agoo Workspace app this many minutes before a rostered shift starts, if they haven't clocked in (10 by default). 0: never.
0 <= value <= 120clock_out_reminder_minutes*integerRemind people on the Agoo Workspace app this many minutes after a rostered shift ends, if they're still clocked in (30 by default). 0: never.
0 <= value <= 240break_punches*booleanBreak punches: Start break and End break on the kiosks and in the Agoo Workspace app, organisation-wide (off by default). A punched break replaces the automatic one for that day. Sites can change this.
selfie_retention_days*|How long selfies are kept, in days (90 by default). null: until deleted.
1 <= value <= 3650coordinates_retention_days*|How long coordinates are kept, in days (90 by default); the check's result and accuracy stay with the punch. null: until deleted.
1 <= value <= 3650notices*The current notice for each evidence type, or null where none was published.
updated_at*stringdate-timecurl -X GET 'https://api.agoohq.com/v1/attendance/settings'{ "methods": [ "qr", "pin", "face", "geofence", "terminal" ], "selfie_mode": "optional", "location_evidence": "result", "wifi_check": true, "wifi_identifiers": false, "face_fallback_approval": false, "shift_reminder_minutes": 10, "clock_out_reminder_minutes": 30, "selfie_retention_days": 90, "coordinates_retention_days": 90, "notices": { "face": { "version": 2, "basis": "required", "legal_basis": "legitimate_interests", "text": "Ridge Medical uses face matching on its reception kiosk to record your attendance…", "effective_on": "2026-10-01", "published_at": "2026-09-28T10:00:00Z" }, "selfie": { "version": 1, "basis": "consent", "legal_basis": null, "text": "With your consent, the app takes a photo when you clock in on your phone…", "effective_on": "2026-10-01", "published_at": "2026-09-28T10:00:00Z" }, "location": { "version": 1, "basis": "required", "legal_basis": "employment_contract", "text": "When you clock in on your phone, the app checks that you are at the clinic…", "effective_on": "2026-10-01", "published_at": "2026-09-28T10:00:00Z" } }, "updated_at": "2026-09-28T10:00:00Z"}Review a punch whose face wasn't verified POST
Accepts or rejects a fallback punch (PIN, QR, NFC or supervisor-assisted) after a failed face match: its `face_check` is `not_verified` and its `review.status` is `pending`. These punches form the review queue (`GET /attendance/events?review_status=pending`) and are counted in the summary until reviewed. - `accepted` keeps the punch. `rejected` voids it: it no longer appears or counts. - A punch that isn't awaiting review returns `invalid_state`. **Scope:** `attendance:manage` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.
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.