Clients

Base URL https://api.klockwork.org. Send X-Klockwork-Key or Authorization: Bearer kw_…. An agency key acts as the agency that created it. JSON bodies use these fields. A missing required field returns 400 with { "error": "Validation failed", "details": {} }.

List clientsCopy Anchor Link

GET /api/public/agency/clients

Query:

Response 200: { clients: Client[] }

Create a clientCopy Anchor Link

POST /api/public/agency/clients

The table below is client. Beside it: invitationSent boolean, linkedImmediately boolean, inviteUrl string or null, and seatQuote with kind (full, partial, or unknown), amountCents integer or null, and label string. A duplicate invoice email returns 400 { "error": "A client with this invoice email is already in the book" }.

Request body:

Response 201: { client, invitationSent, linkedImmediately, inviteUrl, seatQuote }

Get a clientCopy Anchor Link

GET /api/public/agency/clients/{id}

An unknown id returns 404 { "error": "Client not found" }.

Response 200: { client: Client, summary: ClientSummary }

Summary on the get response:

Update a clientCopy Anchor Link

PATCH /api/public/agency/clients/{id}

Every field is optional. Send only the fields that change.

Request body:

Response 200: { client: Client }

Delete a clientCopy Anchor Link

DELETE /api/public/agency/clients/{id}

Response 200: { ok: true }

Invite a clientCopy Anchor Link

POST /api/public/agency/clients/{id}/invite

No request body.

Response 200: { client, invitationSent, linkedImmediately, inviteUrl, seatQuote }

Revoke a client inviteCopy Anchor Link

POST /api/public/agency/clients/{id}/invite/revoke

No request body.

Response 200: { client, invitationSent }

Cover a client's premiumCopy Anchor Link

POST /api/public/agency/clients/{id}/cover

charge.status is transitioned, canceled_sponsored, unchanged, or ledger_only. charge.checkoutEnabled is false. charge.reason and charge.parentMonthlyCents are present only for some outcomes.

No request body.

Response 200: { client, charge }