Get a person
Returns one host or employee, including deactivated people.
Scope: people: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: people:read
person_id*stringThe person's ID.
^person_[0-7][0-9a-hjkmnp-tv-z]{25}$"person_01kjsesxm0e4zbyvkr7bcfxbfg"The person.
application/json- response
A host or employee in your directory.
id*PersonIdA person ID (TypeID with the person prefix).
^person_[0-7][0-9a-hjkmnp-tv-z]{25}$"person_01kjsesxm0e4zbyvkr7bcfxbfg"name*string1 <= length <= 120"Kwame Mensah"email*|email"kwame.mensah@voltabank.example"phone*|E.164 phone number.
^\+[1-9][0-9]{7,14}$"+233205550142"job_title*|length <= 120"Head of Treasury"department*|length <= 120"Treasury"employee_number*|length <= 40"VB-0142"site_ids*array<>The sites this person works at.
can_host*booleanWhether visitors can choose this person as their host.
tracks_attendance*booleanWhether this person clocks in and out.
works_gate*booleanWhether this person can sign in on gate devices at their sites with their own PIN, with or without an Agoo account. People whose role works the gate (security leads, receptionists, guards and admins) can anyway.
visitors_via*|Who receives this person's walk-in visitors for them: a visitor who arrives without an invitation and asks
for this person waits with their office, which asks the person, takes the visitor, books them in for another
time or turns them away. null: visitors go straight to the person. It never applies to visitors the person
invited or to bookings. Set in Console → People.
kiosk_listed*booleanfalse when the person is left out of what a visitor can search at the kiosk and on your visitor pages. A
visitor who asks for them is received by their office (visitors_via), or by the front desk. Your staff
can still invite visitors for them. Set in Console → People.
status*PersonStatusactive, or deactivated (kept for history; can't host, clock in or sign in).
"active""deactivated"custom_fields*Answers to your organisation's custom fields, keyed by field key. The keys and allowed values come from the
JSON Schema of the matching form (GET /forms). Keys that aren't in the form are rejected. Questions the
form marks as required aren't enforced through the API; they're asked when the visitor checks in or
completes their pre-registration. Answers to fields an admin marked sensitive or masked are never included
for API keys or connected apps, nor in events and webhooks: they stay inside Agoo, seen only by the roles the
admin chose.
{ "vehicle_plate": "GR 4521-24", "bringing_laptop": true}created_at*stringdate-timeupdated_at*stringdate-timedeactivated_at*|date-timemanager_id*|Their line manager, who sees their attendance and leave and approves their leave and timesheets. null: no manager.
started_on*|When they started working for you.
date"2023-09-04"left_on*|When they left. Set to the day they're deactivated when it isn't set already, and cleared if they're reactivated.
dateemployment_type*EmploymentTypeHow they're employed. New people are permanent unless you say otherwise.
"permanent""temporary""casual""part_time"contracted_hours*|Contracted hours a week, for part-time people without a roster. null: not set.
0.5 <= value <= 8024curl -X GET 'https://api.agoohq.com/v1/people/person_01kjsesxm0e4zbyvkr7bcfxbfg'{ "id": "person_01kjsesxm0e4zbyvkr7bcfxbfg", "name": "Kwame Mensah", "email": "kwame.mensah@voltabank.example", "phone": "+233205550142", "job_title": "Head of Treasury", "department": "Treasury", "employee_number": "VB-0142", "site_ids": [ "site_01kjpt3yw0fz0v414608h9x65s" ], "can_host": true, "tracks_attendance": true, "works_gate": false, "visitors_via": null, "kiosk_listed": true, "status": "active", "custom_fields": {}, "created_at": "2026-03-03T09:00:00Z", "updated_at": "2026-10-06T14:30:00Z", "deactivated_at": null, "manager_id": "person_01kjsf3c00ecxs9b3k1hw7wq2n", "started_on": "2021-06-14", "left_on": null, "employment_type": "permanent", "contracted_hours": null}Create a person POST
Adds a host or employee to your directory. Give an email address or a phone number (or both) so Agoo can notify them when visitors arrive: with neither, the request returns `validation_failed` at `body.email` and `body.phone`. - Fires `person.created`. - Counts towards your plan's host and attendance limits. Going over a limit returns `plan_required`. - Returns `conflict` if another person already uses the email address. **Scope:** `people:write` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.
Update a person PATCH
Changes a person's details. Send only the fields you want to change; fields you leave out stay as they are. `custom_fields` are merged key by key, and a key set to `null` is removed. - Fires `person.updated`. - A deactivated person can't be updated (`invalid_state`), except to correct `started_on` and `left_on`. - A `manager_id` that is the person, someone who reports to them, a deactivated person or no one in your directory is `validation_failed` on that field. - Returns `conflict` if another person already uses the new email address. **Scope:** `people:write` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.