List people's evidence status
/attendance/evidenceReturns, for one evidence type, each active person on attendance with their status, sorted by person. Use
status=unacknowledged for everyone who hasn't acknowledged the current notice yet, or status=no_consent
in consent mode.
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
Query Parameters
How many items to return, from 1 to 100.
1 <= value <= 10025The next_cursor from the previous page. Leave it out for the first page.
length <= 512Which evidence type.
Value in
- "face"
- "selfie"
- "location"
Only people with this status.
Value in
- "off"
- "acknowledged"
- "unacknowledged"
- "consented"
- "no_consent"
Only people at this site, with the status that applies there.
^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/attendance/evidence?limit=25&evidence=face"{ "data": [ { "person_id": "person_01kjw4mg80efgb5aqbsqnxhtbh", "evidence": "face", "status": "unacknowledged", "basis": "required", "notice_version": 2, "record": null } ], "next_cursor": null, "has_more": false}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.
Get a person's attendance evidence GET
Returns, for face, selfie and location evidence, whether it applies to the person and their latest acknowledgement or consent, and the kiosks their face is enrolled on. Face templates stay on the kiosks: Agoo records only where a person is enrolled. People can read their own; reading anyone else's needs `attendance:read`. **Scope:** `attendance:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.