List clients
The organization's client and guest directory. Shared by both engines, since a client record means the same thing to a salon and a restaurant, so there is no wrong_vertical failure here.
Newest first. No date filters, because a directory is not time-shaped, and no search parameter: page through the whole list with cursor.
Authorization
bearerApiKey clients:readBuild with a test key (sk_test_...): it works only in your API sandbox and never emails or texts anyone. Scopes, errors and limits.
In: header
Scope: clients:read
Query Parameters
Clamped, never rejected: values below 1 or unparseable fall back to 50, values above 200 become 200. A ?limit=1e9 from a program is far more likely to be a client bug than an attack, and answering 200 rows beats answering an error it retries in a loop.
1 <= value <= 20050The nextCursor from the previous response, passed back unchanged. Omit it for the first page. Opaque: it is base64url of an internal position and the encoding is not part of the contract; treat it as a token, do not construct one. A cursor this API did not issue is a 400 invalid_cursor rather than a silently-ignored parameter, because silently restarting at page one is how a paging loop becomes an infinite one.
The scheme is keyset (seek) paging on (order column, id), not OFFSET. OFFSET is wrong under concurrent writes: a booking created between page 1 and page 2 shifts every later row back by one, and the caller silently never sees whichever row slid across the boundary. Filters and limit may change between pages; the cursor only says where you got to.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/clients"{ "data": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "user@example.com", "phone": "string", "createdAt": "2019-08-24T14:15:22Z", "lifetimeSpend": { "totalCents": 0, "checkCount": 0, "currency": "string", "lastCheckAt": "2019-08-24T14:15:22Z" } } ], "nextCursor": "string"}Fetch a webhook eventGET
Returns one webhook event by the id a delivery carried (the body's `id`, or the `Gaplessly-Event-Id` header), in the same envelope the delivery had: `id`, `type`, `createdAt` and `data: { object, changes }`. For a receiver that cannot check `Gaplessly-Signature`, such as a no-code tool that only sees the parsed body: fetching the event with your key confirms Gaplessly sent it, and the answer is what to act on. `object` is the booking, client, check, message or enquiry as it is **now**, built the same way the delivery built it at send time, so a change made since can show here first. **Scopes.** `webhooks:write` plus the read scope for the event's data, the same pair subscribing to that event needs: `reservations:read` for a table booking, a till's check or an enquiry, `appointments:read` for an appointment, `clients:read` for `guest.created` and `guest.merged`, `messages:read` for `message.received`. A test `ping` needs only `webhooks:write`. **Kept 30 days**, while its delivery log is. An event from another organization, one older than that, or one whose endpoint was removed is a `404`, the same answer as an id that never existed. A `404` with `code: subject_deleted` means the event was real but what it was about has since been deleted.
Read the organizationGET
The calling organization's own profile and settings, and the operation that makes the rest of the API navigable: `businessType` is how a program learns which engine it is talking to, and so which set of endpoints applies. Shared, so it answers for both engines. A **singleton**: the envelope is `{ data: { … } }` with an object, and there is no `nextCursor`, `limit` or `cursor`. Every v1 response is still unwrapped the same way, from `data`. `timezone` is the organization's IANA zone. The wall-clock times on `GET /api/v1/service-periods` are expressed in it, and `startsAt`/`endsAt` on bookings carry its offset for their date. `currency` and the `deposit*` fields are what a program needs to quote a deposit without guessing. There is deliberately **no `organization:write` scope**: the slug, status and engine are not something a long-lived, program-held credential should be able to change.