Get a site
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.
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: sites:read
site_id*stringThe site's ID.
^site_[0-7][0-9a-hjkmnp-tv-z]{25}$"site_01kjpt3yw0fz0v414608h9x65s"The site.
application/json- response
A location of your organisation, with its gates and kiosks.
id*SiteIdA site ID (TypeID with the site prefix).
^site_[0-7][0-9a-hjkmnp-tv-z]{25}$"site_01kjpt3yw0fz0v414608h9x65s"name*string"Ridge HQ"time_zone*stringIANA time zone for the site's days and shifts.
"Africa/Accra"address*A postal address.
location*|The site's position, used for geofenced clock-in. null if not set.
gates*array<>devices*array<>created_at*stringdate-timeupdated_at*stringdate-timecurl -X GET 'https://api.agoohq.com/v1/sites/site_01kjpt3yw0fz0v414608h9x65s'{ "id": "site_01kjpt3yw0fz0v414608h9x65s", "name": "Ridge HQ", "time_zone": "Africa/Accra", "address": { "line1": "12 Independence Avenue", "line2": null, "city": "Accra", "region": "Greater Accra", "country": "GH" }, "location": { "latitude": 5.56, "longitude": -0.1969 }, "gates": [ { "id": "gate_01kjpt5sf0fgyvy00hg9tg68m2", "name": "Main gate" }, { "id": "gate_01kjpt7m20fpf9vcsaexsxgqr3", "name": "Lobby" } ], "devices": [ { "id": "dev_01kjywram0esxva8np5wzj6fre", "name": "Lobby iPad", "platform": "ios", "gate_id": "gate_01kjpt7m20fpf9vcsaexsxgqr3", "app_version": "1.4.0", "last_seen_at": "2026-10-14T09:31:00Z" } ], "created_at": "2026-03-02T08:20:00Z", "updated_at": "2026-09-18T10:05:00Z"}List sites GET
Returns your organisation's sites, oldest first. Each site includes its gates and the kiosks paired to it, so one call gives you everything you need to pick a `site_id` or `gate_id`. **Scope:** `sites:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.
List people GET
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.