> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.hellotracks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# REST API overview

> Plain REST resources over HTTPS, for tools, automations and services.

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](https://api-docs.hellotracks.com/cli/overview) and our Zapier, Make and n8n apps are built on it.

> [!NOTE]
>
> Writing an integration in code? See the [JSON API](https://api-docs.hellotracks.com/api-reference/overview.md). Working from a terminal or with an AI agent? The [CLI](https://api-docs.hellotracks.com/cli/overview.md) 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:

```bash theme={null}
curl "https://api.hellotracks.com/v1/auth/whoami" \
  --header "API-Key: YOUR_KEY_ID.YOUR_SECRET"
```

## Requests and responses

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

```json theme={null}
{
  "data": {
    "items": [
      { "id": "650000000000000000000001", "title": "Boiler service", "progress": "scheduled" }
    ],
    "totalCount": 1,
    "hasMore": false
  },
  "error": null,
  "meta": { "path": "/jobs", "method": "GET" }
}
```

Failed requests answer with an HTTP error status, `data: null` and an `error` with a `code` for your program and a `message` for people:

```json theme={null}
{
  "data": null,
  "error": { "code": "invalid_api_key", "message": "Invalid Hellotracks API key." },
  "meta": { "path": "/jobs", "method": "GET" }
}
```

## Resources

Every route has its own page with parameters, request and response examples.

| Resource | What it covers |
| - | - |
| [Sign-up and sign-in](https://api-docs.hellotracks.com/v1/reference/sign-up-and-sign-in/create-signup.md) | Create a company or get an API key by an emailed code, without a key; and check which account a key belongs to |
| [Company](https://api-docs.hellotracks.com/v1/reference/company/get-company.md) | The company the API key belongs to, with its settings and teams |
| [Members](https://api-docs.hellotracks.com/v1/reference/members/list-members.md) | The people in the company: admins, operators and workers |
| [API keys](https://api-docs.hellotracks.com/v1/reference/api-keys/list-api-keys.md) | The company's API keys: list, create, revoke and delete |
| [Jobs](https://api-docs.hellotracks.com/v1/reference/jobs/list-jobs.md) | Jobs: work at a location on a date, assigned to a member |
| [Places](https://api-docs.hellotracks.com/v1/reference/places/list-places.md) | Places: customer sites and other saved locations with a check-in radius |
| [Zones](https://api-docs.hellotracks.com/v1/reference/zones/list-zones.md) | Zones: the company's geofences |
| [Routing](https://api-docs.hellotracks.com/v1/reference/routing/optimize-route.md) | Route optimization for one member's day |
| [ETA pages](https://api-docs.hellotracks.com/v1/reference/eta-pages/list-eta-sessions.md) | Live ETA pages (eta.page links) that show a job's recipient when the worker arrives |
| [Maps](https://api-docs.hellotracks.com/v1/reference/maps/list-map-layers.md) | Rendered maps as GeoJSON, and public map share links |
| [Timesheets](https://api-docs.hellotracks.com/v1/reference/timesheets/list-timesheets.md) | Clock-in and clock-out entries of members, with totals, and editing them |
| [Forms](https://api-docs.hellotracks.com/v1/reference/forms/list-form-templates.md) | Form templates, submitted forms, attachments for file and image fields, and forms linked to places and jobs |
| [Alerts](https://api-docs.hellotracks.com/v1/reference/alerts/list-alert-actions.md) | Alert rules (configs) that watch members, places and zones, and the alerts (instances) they raised |
| [Reports](https://api-docs.hellotracks.com/v1/reference/reports/list-report-catalog.md) | Reports: the newer reporting API (catalog, preview, run, saved) and the older one (types, generate, jobs, uploads, recurring) |
| [Webhooks](https://api-docs.hellotracks.com/v1/reference/webhooks/list-webhooks.md) | URLs Hellotracks calls when jobs, check-ins, clock-ins or alerts happen |

See [No-code connectors](https://api-docs.hellotracks.com/v1/no-code-connectors.md) for what our Zapier, Make and n8n apps send.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.