API reference

Every endpoint an integration uses, by area: 314 in all. Each one lists its parameters and fields, and gives a cURL example you can run with your API key.

New here? Start with the quickstart. Requests, errors, paging and limits are explained once in API basics.

Core#

People24 endpoints: Add a person (sends an invite by default) · Do the same thing to many people (suspend, archive, resend invitesOpen →Locations7 endpoints: Who manages this location (here, from a region above, or workspace-wide) · List locations (flat; build the treOpen →Geofences6 endpoints: Open →Roles4 endpoints: Open →External IDs6 endpoints: The kinds of external ID this workspace keeps, with how many people have each, plus presets not yet added · KeOpen →Directory7 endpoints: Find a workspace (and its region + branding) by work email or workspace slug · Catalogues: event types, permisOpen →

Time#

Time entries10 endpoints: Add an entry for someone (admin) · Switch project/activity while on shiftOpen →Punches2 endpoints: Clock in / out / break. Idempotent on local_id. · Upload queued offline punches in order. Each is applied indeOpen →Timesheets10 endpoints: Period grid: one row per personOpen →Edit requests4 endpoints: Ask a manager to fix or add an entryOpen →Exceptions2 endpoints: Open →Live2 endpoints: Who is on site, on break, late — right now · Server-sent events for changes in your scopeOpen →Kiosks8 endpoints: A tablet trades the short pairing code from the console for its kiosk token (15 minutes, once) · Kiosk boot inOpen →

Planning#

Schedule31 endpoints: Week board: shifts, time off and hours worked per person · Add a weekly shiftOpen →Time off13 endpoints: Requests I can see (mine, or my team's) · Ask for time off (or add it for someone you manage, approved straighOpen →Holidays4 endpoints: Holidays for a year: the workspace's, a location's, or mine · Holiday calendars you can choose from · Add a coOpen →Site requests6 endpoints: Whether people can ask for sites here, and the sites they could ask to join · My requests, plus the ones I canOpen →

Work and billing#

Projects17 endpoints: Clients work is billed to, with how many projects and sites each has · Add a client · One client with its siteOpen →Invoices20 endpoints: Where this invoice was sent: one row per accounting connection, with its number and link there · Invoices you Open →Notes6 endpoints: Notes on something, newest first · Add a typed note, or a voice note from an uploaded recording (transcribed aOpen →Media8 endpoints: Whether voice notes can be transcribed in this workspace, and upload limits · Photos (and recordings) on a proOpen →

Reports#

Reports18 endpoints: Download an export with a signed link (valid 24 hours) · KPIs and charts for the Overview dashboardOpen →Insights6 endpoints: Unusual patterns in the sites I look after, most important first · When insights were last checked · Check forOpen →

Integrations#

Webhooks11 endpoints: Subscribe a URL to events ("*" for all). The signing secret is returned once.Open →Events1 endpoint: Pull events (alternative to webhooks; 30-day retention). Use after_id to page forward.Open →API keys5 endpoints: The test-data workspace that test keys (tt_test_…) work in · Replace the test data with fresh sample data (keyOpen →Connections51 endpoints: Systems ClockLap connects to, with whether each can connect directly here · Add a connection. It starts in setOpen →

Workspace#

Policies5 endpoints: Effective policy with the source of every value · Replace this location's override patch ({} = inherit everythOpen →Settings4 endpoints: Bring your own AI: connected providers (keys are never shown), usage this month, limits · Connect or replace aOpen →Compliance5 endpoints: Electronic monitoring policy: saved answers, live preview from current settings, and every published version ·Open →Audit1 endpoint: Open →Branding10 endpoints: Render tokens for an unsaved theme (used by the live preview) · Download an asset (logos are public; photos neOpen →

OpenAPI file#

The full machine-readable description (OpenAPI 3.1) is served by each region at /docs/json, for example ca-api.clocklap.com/docs/json. Import it into Postman, Insomnia or a code generator.