REST API overview - Hellotracks developer docs

The REST API lives at https://api.hellotracks.com/v1. It uses ordinary HTTP methods on resources, query strings for filters and JSON bodies for changes, which makes it the natural base for tools and automations. Our own ht command line and our Zapier, Make and n8n apps are built on it.

Writing an integration in code? See the JSON API. Working from a terminal or with an AI agent? The CLI wraps this REST API in one command per task.

Authentication

Send your API key, from More → API & Integrations in the dashboard, in the API-Key header:

curl "https://api.hellotracks.com/v1/auth/whoami" \
  --header "API-Key: YOUR_KEY_ID.YOUR_SECRET"

Requests and responses

curl "https://api.hellotracks.com/v1/jobs?date=2026-11-02&limit=50" \
  --header "API-Key: YOUR_KEY_ID.YOUR_SECRET"

{
  "data": {
    "items": [
      { "id": "650000000000000000000001", "title": "Boiler service", "progress": "scheduled" }
    ],
    "totalCount": 1,
    "hasMore": false
  }
}

Failed requests return an error object with a code for your program and a message for people:

{ "error": { "code": "invalid_api_key", "message": "Invalid Hellotracks API key." } }

Resources

Resource	Paths
Account	`GET /auth/whoami`, `GET` and `PATCH /company`
Jobs	`GET`, `POST`, `PATCH /jobs`; `GET`, `PATCH`, `DELETE /jobs/{id}`; `POST /jobs/{id}/archive`, `/restore`
Members	`GET`, `POST /members`; `GET`, `PATCH`, `DELETE /members/{id}`
Places and zones	`GET`, `POST /places`; `GET`, `PATCH /places/{id}`; `GET /zones`
Routing	`POST /routing/optimize`
Timesheets	`GET /timesheets`; `POST`, `PATCH`, `DELETE /timesheets/entries`
Forms	`/forms/templates`, `/forms/submissions`, `/forms/attachments`, `/forms/links`
Alerts	`/alerts/actions`, `/alerts/configs`, `/alerts/instances`
Reports	`/reports/catalog`, `/reports/run`, `/reports/saved`
ETA pages	`/eta/sessions`
Maps	`/maps/layers`, `/maps/render`, `/maps/shares`
Webhooks and keys	`GET`, `PUT /webhooks`; `/apikeys`

Prototype: a full page per resource will come from an OpenAPI description of these routes.

See No-code connectors for what our Zapier, Make and n8n apps send.

​Authentication

​Requests and responses

​Resources

Authentication

Requests and responses

Resources