API overview
The Tracker API lets your own systems do everything the admin does:
- create visits from your job system;
- send operatives' positions from your own app or vehicle telematics;
- manage operatives and the dispatch board.
The admin is built on the same API, so anything you see there you can automate.
Basics
- Base URL:
https://<your Tracker host>/api. Integration endpoints are under/v1. - Format: JSON in, JSON out, UTF-8. Times are ISO 8601 with an offset, for example
2026-11-02T09:00:00Z. - Authentication: an API key as a bearer token. See Authentication.
- Errors: a consistent JSON body with a machine-readable
code. See Errors.
The main objects
| Object | What it is |
|---|---|
Visit (journey) | One trip to one customer, with a status, destination, optional appointment window and operative. |
| Tracking token | The secret in the customer's link (/t/<token>). It's the only credential the tracking page needs, so treat it like a password. |
| Share-location link | The operative's link (/t/share/<token>) for sharing location from a browser without the app. |
| Operative | A person who travels to visits. Counts towards the plan's active operatives. |
| Dispatch board | Per day, the lanes of visits for each operative, in order. |
A visit's life
- Create the visit:
POST /v1/journeys. The customer gets the booked message with their link. - Start when the operative sets off:
POST /v1/journeys/{id}/start, ideally with their first position. Tracker works out the route and arrival time, and the customer gets the "on the way" message. - Positions while they travel:
POST /v1/journeys/{id}/positions, in batches. - Arrive:
POST /v1/journeys/{id}/arrive, or automatically when a position is within 60 m of the destination.
The Tracker app makes steps 2–4 for you. Only use them yourself if positions come from your own app or telematics. Walk through all four in the quick start.