Looking for every endpoint and schema in one place? See the Full OpenAPI reference.
Base URL
https://trackthatride.com/api/v1All requests and responses are JSON over HTTPS. Times are ISO 8601 strings. This reference lists 45 endpoints, read directly from the API’s router when this site is built, so every endpoint listed exists.
Sections
- API quickstart: Your first authenticated request in five minutes.
- Authentication: API keys, permissions and how to send them.
- Deliveries (rides) API: Create, update, assign and follow deliveries.
- Drivers API: Create drivers and assign them to zones.
- Zones API: Manage delivery zones.
- Customers API: Customer records, history and updates sent.
- Webhooks: Events, payloads and signature verification.
- Public tracking and real-time streams: The public tracking endpoint and Server-Sent Events.
- Errors and rate limits: Status codes, error codes and per-key limits.
Machine-readable specification
An OpenAPI 3.0 description is served at /api/openapi.json. It predates some recent endpoints and lists a few routes that only accept a dashboard session, not an API key; where it and this reference differ, this reference reflects the current router.
Conventions
- Deliveries are called “rides” in the API, for historical reasons. A ride is one pickup and one drop.
- Statuses are
pending,assigned,in_progress,delivered,failedandcancelled. - Errors return a non-2xx status with a JSON body containing
errorand usuallymessageorcode. See errors and rate limits. - Company scope: an API key belongs to one company and only ever sees that company’s data.