Docs
API referenceSites

List sites

Preview· P9
GET/sites

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.

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

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

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?limit=25"
{  "data": [    {      "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"    },    {      "id": "site_01knvdere0f738bjjhnyhtyv2z",      "name": "Tema Branch",      "time_zone": "Africa/Accra",      "address": {        "line1": "Community 1, Harbour Road",        "line2": null,        "city": "Tema",        "region": "Greater Accra",        "country": "GH"      },      "location": null,      "gates": [        {          "id": "gate_01knvdgk10e929rv9vt49a50nf",          "name": "Main gate"        }      ],      "devices": [        {          "id": "dev_01knxw9ym0e97rw3d55fwfmt66",          "name": "Tema reception tablet",          "platform": "android",          "gate_id": null,          "app_version": "1.4.0",          "last_seen_at": "2026-10-14T09:29:45Z"        }      ],      "created_at": "2026-04-10T10:02:00Z",      "updated_at": "2026-04-11T09:00:00Z"    }  ],  "next_cursor": null,  "has_more": false}

Get the organisation GET

Returns the organisation that the API key or access token belongs to, including its plan and prepaid wallet balance. Use it to check which organisation and mode (`livemode`) a key works on. **Scope:** `organisation:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.

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.