Quickstart

This page shows the shortest path from “I have a JWT” to “I got data back”.

1. Prerequisites

   You need:

   • A valid Bearer JWT for your integration — see Authentication to exchange client credentials, then paste the token into Authorize in the API Reference.
   • A siteId and a checkinId your caller is allowed to access. The site identifies where the checkin happened; the UUID identifies which checkin.

   The base URL is:

   https://aware-api.invalid/api/v1

   Every public route lives under /api, with the version segment after that (/api/v1). On the deployed docs site the host is the same origin as this page (for example /api/v1).

2. Read a checkin

   curl -sS \
     -H "Authorization: Bearer $AWARE_ACCESS_TOKEN" \
     -H "Accept: application/json" \
     "https://aware-api.invalid/api/v1/sites/54321/checkins/people/8f5b9a4d-3c2e-4b1f-9d8a-72e6c1f0a4b3"

   A successful response looks like:

   {
     "id": "8f5b9a4d-3c2e-4b1f-9d8a-72e6c1f0a4b3",
     "siteId": 54321,
     "personId": 24680,
     "timestamp": "2026-05-12T22:15:33.000Z",
     "status": "IN",
     "entry": {
       "source": "USER",
       "timestamp": "2026-05-12T22:15:33.000Z"
     },
     "breaks": []
   }

3. Common headers to know

   • Authorization — Bearer <jwt>, required on every protected request.
   • Idempotency-Key — send on writes to make retries safe. See Idempotency.
   • X-Request-Id — we echo this back in every response. Send your own to make debugging easier.
   • RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset — returned when rate limiting applies. See Rate limits.

4. Next steps

   Try it

   API Reference

   Browse every endpoint.

   Conventions

   IDs and timestamps

   Stable public IDs and ISO-8601 timestamps.

   One envelope

   Errors

   Map our type codes to your error handling.