TerraGo
terra API
One API behind the school product, the WaaS beneficiary rail and TerraPass. Every endpoint below is generated from the live route table — the paths, the audiences, the capabilities and the request bodies are the ones the server actually enforces.
Start here
Conventions
Base URLs, the bearer token, the device fingerprint every app surface must send, envelopes, cursor pagination, idempotency and rate limits.
Errors
The RFC 9457 problem document and every code the API can raise, scanned from the call sites that raise them.
Schemas
The wire shapes responses are built from — the same catalog the generated SDKs are typed against.
Modules
Access 47
Taps, presence and credentials — the gate rail. One `tap` write serves a school gate and a stadium door.
/v3/band /v3/band-type /v3/device /v3/portal /v3/presence /v3/student
Intelligence 5
/v3/portal
Legacy 333
The WaaS/TerraGo v2 compatibility surface. Shapes here are frozen for existing clients; new work belongs on the v3 modules.
/v3/waas
Messaging 26
WhatsApp, SMS and in-app notifications, their templates and delivery records.
/v3/app /v3/notification /v3/portal /v3/webhook
Money 58
Wallets, the double-entry ledger, payment intents, payouts and settlements.
/v3/app /v3/invoice /v3/pay /v3/payment-intent /v3/portal /v3/pos-category
Pass 56
TerraPass — events, doorlists, tiers, shifts, the till and the fan surface.
/v3/auth /v3/pass /v3/webhook
People 47
Accounts, students, guardians, staff and the invitations that mint them.
/v3/account /v3/app /v3/auth /v3/group /v3/pass /v3/portal
Platform 59
Auth, sessions, devices, tenants, roles, sync feeds and the health probes.
/healthz /heartbeatz /readyz /v3/app /v3/auth /v3/bootstrap
Reporting 17
Aggregates and exports — read-only views over the same rows the operational screens read.
/v3/app /v3/portal
Terrago 14
/v3/portal
Transport 42
Trips, routes, vehicles, positions and the geo services behind them.
/v3/app /v3/geocode /v3/portal /v3/track /v3/trip /v3/webhook
Ussd 1
/v3/ussd