Getting Started

What is Trackee?

Trackee provides an API and dashboard for organization-scoped tracking workflows. Each organization manages its own access keys, and every protected API request is associated with the organization that owns the key.

Start the API

From the repository root, start the API workspace:

pnpm --filter @trackee/api dev

The local API listens on http://localhost:3001 by default.

Check the service

The health endpoint does not require authentication:

curl http://localhost:3001/health

{
  "service": "api",
  "status": "ok"
}

Make an authenticated request

Create an access key from the Trackee dashboard, then send it in the x-access-key header:

curl http://localhost:3001/v1/whoami \
  -H "x-access-key: YOUR_ACCESS_KEY"

The response identifies both the access key and its organization:

{
  "accessKeyId": "key_123",
  "organizationId": "org_123"
}

Continue with Authentication to learn how keys are created and used.