Docs
API referenceAttendance

Get an attendance summary

Preview· P9
GET/attendance/summary

Counts, for each day in a range, how many people on attendance were present, late, on leave or absent. Each person counts once per day, in exactly one of the four. Days are whole days in the site's time zone (or your organisation's, without site_id). The range can span up to 31 days.

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

from*string

First day of the range (inclusive), as YYYY-MM-DD.

Formatdate
to*string

Last day of the range (inclusive), as YYYY-MM-DD. At most 31 days after from.

Formatdate
site_id?string

Only people assigned to this site. Leave it out for the whole organisation.

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/summary?from=2026-10-13&to=2026-10-14"
{  "from": "2026-10-13",  "to": "2026-10-14",  "site_id": "site_01kjpt3yw0fz0v414608h9x65s",  "time_zone": "Africa/Accra",  "totals": {    "present": 80,    "late": 8,    "on_leave": 4,    "absent": 4  },  "days": [    {      "date": "2026-10-13",      "present": 41,      "late": 3,      "on_leave": 2,      "absent": 2    },    {      "date": "2026-10-14",      "present": 39,      "late": 5,      "on_leave": 2,      "absent": 2    }  ]}

Record a clock-in or clock-out POST

Records a clock-in or clock-out from your own terminal, such as a turnstile or a biometric reader you already run. The event's `method` is always `terminal`. - Your terminal can send evidence your organisation has switched on at the site: `selfie_file_id` (a `selfie` file), `location` (with `latitude` and `longitude` only when your organisation keeps coordinates) and `wifi` (with `ssid` and `bssid` only when it keeps them). Evidence that's off returns `validation_failed` at that field. In consent mode, evidence for someone who hasn't consented returns `consent_required`. - Terminal punches must be switched on at the site (they are by default). - Send the time it happened as `occurred_at`. You can send punches late, for example after a network cut; Agoo places them by `occurred_at`. It can't be in the future. - Fires `attendance.clocked_in` or `attendance.clocked_out`, and `attendance.late` when a clock-in is later than the person's shift start plus its grace period. - The person must be active and on attendance (`tracks_attendance: true`); otherwise you get `invalid_state`. **Scope:** `attendance:write` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.

List shifts GET

Returns your shift patterns, sorted by name. Shift times are local times in the site's time zone. Agoo uses them, with the grace period, to decide who is late. **Scope:** `attendance:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.