Docs
API referencePeople

List people

Preview· P9
GET/people

Returns the hosts and employees in your directory, newest first. Filter by name, email, site or status, for example to find the host_id for an invitation.

Scope: people: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: people: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
q?string

Matches the start of any word in the person's name, or their email address. Case-insensitive.

Length2 <= length <= 100
email?string

Exact email address, case-insensitive.

Formatemail
site_id?string

Only people assigned to this site.

Match^site_[0-7][0-9a-hjkmnp-tv-z]{25}$
Example"site_01kjpt3yw0fz0v414608h9x65s"
status?string

Only people with this status. Defaults to active.

Value in

  • "active"
  • "deactivated"
can_host?boolean

Only people who can (or can't) host visitors.

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/people?limit=25&q=Kwame&email=kwame.mensah%40voltabank.example&can_host=true"
{  "data": [    {      "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,      "status": "active",      "custom_fields": {},      "created_at": "2026-03-03T09:00:00Z",      "updated_at": "2026-10-06T14:30:00Z",      "deactivated_at": null    }  ],  "next_cursor": null,  "has_more": false}

Get a site GET

Returns one site with its address, time zone, gates and paired kiosks. The site's IANA time zone is the one Agoo uses for that site's days, shifts and summaries. **Scope:** `sites:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.

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.