Aware Public API

v1 · Stable

Build on Aware.

The Aware Public API is the supported, versioned surface for integrators who want to build on top of the Aware platform - dedicated infrastructure, Bearer JWT auth, stable IDs.

Quickstart

API Reference

What you can do today

The first release covers checkin-related data:

Read

Get a checkin by ID

Look up a single checkin and the breaks recorded on it.

Read

Search checkins

Filter checkins by site, person, and time range.

Write

Create a checkin

Check a person in to a site, idempotency-key supported.

Write

End a checkin

Cleanly check a person out - completes any open breaks.

Write

Start a break

Start a break on an active checkin.

Write

End a break

End the currently active break on a checkin.

The full surface is documented in the API Reference.

Designed for integrators

Conventions

IDs and timestamps

One ID space and one ISO-8601 timestamp format used in every URL, request, and response.

One error envelope

Predictable error shapes

Every error response shares the same JSON shape with a small fixed set of type values.

JWT

Bearer authentication

Authorization: Bearer … on every protected request, verified against your Aware integration’s JWKS.

Standard headers

Rate limits

RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, Retry-After.

Safe retries

Idempotency-Key on writes

Send the same key twice and we deduplicate. Records expire after 24h.

Stable

Versioned at /v1

Breaking changes require a new versioned path and a deprecation window. Track everything in the changelog.

Get started

5 min

Quickstart

Send your first request with curl or fetch.

JWT

Authentication

Obtain and send a Bearer JWT.

Try it

API Reference

Every endpoint and field, with a built-in Try it panel.