Docs
API referenceAttendance

List people's evidence status

Preview· P9
GET/attendance/evidence

Returns, 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.

Authorization

AuthorizationBearer <token>

Send Authorization: Bearer <token> on every request. The token is one of:

PrefixWhat it isWhere it may be used
agoo_sk_live_Secret key, live modeYour servers only
agoo_sk_test_Secret key, test modeYour servers only
agoo_pk_live_Publishable key, live modeBrowsers 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 modeAs 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

limit?integer

How many items to return, from 1 to 100.

Range1 <= value <= 100
Default25
cursor?string

The next_cursor from the previous page. Leave it out for the first page.

Lengthlength <= 512
evidence*string

Which evidence type.

Value in

  • "face"
  • "selfie"
  • "location"
status?string

Only people with this status.

Value in

  • "off"
  • "acknowledged"
  • "unacknowledged"
  • "consented"
  • "no_consent"
site_id?string

Only people at this site, with the status that applies there.

Match^site_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example"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}