Quickstart

Go from zero to a completed lesson and a compliance report in about five minutes, using nothing but curl and the public sandbox. No account, no signup, no configuration.

tbm_test_wWlSr6q-BPXUN67BPbzyVhR703QGmSlk34EEWGqRBtA

1 Ask where E-1001 stands today

One call answers the only question most integrations need: has this employee finished today's lesson? Copy and run:

# Check today's status for sandbox employee E-1001
curl "https://toolboxminute.com/api/v1/employees/E-1001/today" \
  -H "X-Api-Key: tbm_test_wWlSr6q-BPXUN67BPbzyVhR703QGmSlk34EEWGqRBtA"

2 Read the response

You get today's status plus, because the lesson is not finished yet, a single-use launchUrl. Your lesson title and date will differ; the shape will not:

{
  "externalId": "E-1001",
  "lessonDate": "2026-07-15",
  "status": "not_started",
  "lesson": {
    "lessonId": "7d0e3c2a-4b91-4f6e-9a35-c8f2d1e0b647",
    "title": "Pedestrian Awareness",
    "videoDurationSeconds": 90
  },
  "subTopic": "Forklift Safety",
  "topic": "Powered Equipment",
  "launchUrl": "https://toolboxminute.com/viewer/start?token=kX3vQ9..."
}

3 Open the launch URL and finish the lesson

Paste the launchUrl into a browser. That is the exact experience an employee gets from your WMS, kiosk, or daily email: the token signs them in anonymously, the 90 second video plays, and a short quiz confirms they were paying attention. Complete both.

In production you would pass ?returnUrl= on the /today call to control where the employee lands after finishing. Return URLs are exact-match allowlisted per tenant; an unlisted value fails with 400 invalid_return_url.

4 Ask again and see the answer change

Re-run the exact same call from step 1. The status is now completed and no launch URL is issued, because there is nothing left to launch:

{
  "externalId": "E-1001",
  "lessonDate": "2026-07-15",
  "status": "completed",
  "lesson": {
    "lessonId": "7d0e3c2a-4b91-4f6e-9a35-c8f2d1e0b647",
    "title": "Pedestrian Awareness",
    "videoDurationSeconds": 90
  },
  "subTopic": "Forklift Safety",
  "topic": "Powered Equipment",
  "launchUrl": null
}

This loop, ask, redirect, ask again, is the whole integration. Your system decides what a not_started answer means: block a task, nudge a supervisor, or just record it.

5 Pull the compliance roll-up

Reporting endpoints see the completion you just made. The compliance summary is today's tenant-wide roll-up, ready for a BI dashboard or a morning email:

# Today's compliance summary for the whole tenant
curl "https://toolboxminute.com/api/v1/reports/compliance" \
  -H "X-Api-Key: tbm_test_wWlSr6q-BPXUN67BPbzyVhR703QGmSlk34EEWGqRBtA"

# 200 OK
{
  "activeEmployees": 8,
  "completedToday": 1,
  "expectedToday": 8,
  "compliancePercentToday": 12.5,
  "activeBadges": 4,
  "expiringSoon": 1
}

That completedToday: 1 is you. Other reporting endpoints cover per-employee history, daily and date-range activity feeds, and badge expiry.

Going live

Three changes take this walkthrough to production:

Next: read Authentication for key classes, rotation, and the exact error bodies, or point your tooling at the machine-readable OpenAPI document at https://toolboxminute.com/api/openapi/v1.json.