TerraGo API Reference
30 modules, 240 endpoints. Method, URL, auth requirement,
request body, and a sample response for each, pulled from the TerraGo
Postman collection.
This covers the API two ways. The module pages below are the
routes themselves, pulled straight from the Postman collection
with method, auth, body, and a real response for each one. The
Used By UI Screens list in the sidebar covers the same ground from the
other side: which screens call which endpoints, traced by hand
through the frontend store and component code. A few of those
calls aren't in the Postman collection yet — they're marked as
such rather than left out.
Endpoints used on a given page carry a "Used On" tag linking to it, so you can go either direction.
Endpoints used on a given page carry a "Used On" tag linking to it, so you can go either direction.
Admin APIs
System-admin-only endpoints, used by the admin dashboard in TerraGoNewUI.
API Modules
Auth
Authentication and session lifecycle. Covers login (v1, plus the v2 staff zone/location-selection flow), zon…
8 endpoints
Users
All human accounts on the platform: parents, school administrators (Administrative Staff) and staff (drivers…
13 endpoints
Students
Students (children) transported by the platform. Covers student CRUD, guardian links, home addresses, Band/B…
24 endpoints
Guardians
Alternate authorized adults, besides the parent, permitted to drop off or collect a child. Endpoints to crea…
5 endpoints
Roles
Read-only lookup of the platform's role definitions (System Admin, Administrative Staff, Staff, Parent). Use…
1 endpoint
AccessLogs
Gate and tap access records — when a student was checked in or out at a zone/location. List and filter the l…
5 endpoints
Tags
TerraGo-sourced beneficiary/route tags used to categorize and filter students and zones/locations. Proxied t…
1 endpoint
Zones/Locations
TerraGo-managed zones/locations — vehicles (mobile zones/locations) and fixed access points such as school g…
4 endpoints
Trips Planners
Recurring or one-off trip schedules (e.g. morning, mid-morning, afternoon runs) with a direction (Home→Schoo…
9 endpoints
Trips
Live and historical trips. Start and complete/close a trip, stream and batch GPS breadcrumbs, fetch the late…
11 endpoints
Alerts & Events
Organization-wide feed of trip alerts and events across every trip (e.g. SOS, speeding, route deviation, har…
1 endpoint
Routes
Named routes and their ordered stops, each tied to a the registry zone/location and tag. Create and update r…
8 endpoints
Devices
Onboard Band/Bag Tags hardware (trackers/scanners). Register devices (admin, public self-registration, and a…
9 endpoints
Airtime
Airtime top-ups for the SIMs inside onboard devices. Buy airtime, review purchase history for a device/accou…
3 endpoints
Band/Bag Tags Types
Read-only lookup of the supported Band/Bag Tags device types (band/tracker models). Used to populate choices…
1 endpoint
Communication
Outbound messaging to parents and guardians. Send trip alert notifications and read communication logs acros…
3 endpoints
Templates
Reusable message templates for notifications (SMS/email/WhatsApp), categorized by purpose. Create or update,…
6 endpoints
IoT Stock
Wearable device (band/tag) inventory management — separate from the `Devices` module, which covers scanners/…
6 endpoints
WhatsApp Flow Menus
Configuration for the menu options shown to parents in the WhatsApp bot flow (System Admin only). Items are …
6 endpoints
Subscription Voucher Codes
Promotional/discount codes parents can redeem against a subscription invoice. Creating, listing, updating, a…
7 endpoints
Payments
Subscription and invoice payments. Initiate an M-Pesa STK-push mobile payment (via the Lipad gateway) and li…
2 endpoints
Roll Call
Manual attendance records marked by staff for a student on a given zone/location/trip. Create, list, fetch, …
5 endpoints
Summaries
Aggregated dashboard summaries for a school — e.g. the roll-call attendance overview — rolled up for quick a…
1 endpoint
Application Cache
Admin key/value store for app-managed runtime configuration held in Redis. Get, set and delete individual ke…
6 endpoints
Callbacks
Inbound webhooks from partner systems — e.g. the the registry access-control callback that records a gate ta…
1 endpoint
Fleet Logs
Vehicle operations records used for cost and efficiency reporting: fuel logs and maintenance logs captured p…
8 endpoints
Reports
Operational and business analytics. Attendance reporting (average, trends, absentees, late arrivals, best on…
17 endpoints
Band/Bag Tags
Read-only lookup of a scanned Band/Bag Tags device by its serial number — returns who the device belongs to …
1 endpoint
V2 (Mobile Sync)
Versioned `/api/v2` endpoints for the driver mobile app: slim, idempotent, offline-first and delta-syncable …
17 endpoints