Get the organisation
/organisationReturns 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.
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.
In: header
Scope: organisation:read
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/organisation"{ "id": "org_01kjpsrza0etzb0a4vf72x8ang", "name": "Volta Bank", "slug": "voltabank", "plan": "pro", "country": "GH", "time_zone": "Africa/Accra", "wallet_balance": { "amount": 29900, "currency": "GHS" }, "livemode": true, "created_at": "2026-03-02T08:14:00Z"}API reference
Every endpoint and webhook event of the Agoo REST API, generated from the OpenAPI 3.1 contract.
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.