Docs

Get a site

Preview· P9
GET/sites/{site_id}

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.

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: sites:read

Path Parameters

site_id*string

The site's ID.

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

curl -X GET "https://example.com/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"}