Developers
Build on Clive
Connect your platform to Clive clinic groups: keep members in sync, book appointments, redeem vouchers and react to what happens at the clinic through signed webhooks. Start in the sandbox with synthetic data.
Your first call
OAuth 2.0 client credentials, JSON over HTTPS. Exchange the client ID and secret from the clinic admin for a token, then ask the API who you are.
- Sandbox
https://sandbox-api.clivehealth.app- Production
https://api.clivehealth.app- Webhooks
- HMAC-SHA256 signed, payload version
2026-10-01
export API=https://sandbox-api.clivehealth.app
export TOKEN=$(curl -sS -X POST "$API/oauth/token" -u "$CLIENT_ID:$CLIENT_SECRET" \
-d grant_type=client_credentials | jq -r .access_token)
curl -sS "$API/public/v1/me" -H "Authorization: Bearer $TOKEN"Start here
- 1
Getting started
Get an API client from the clinic admin, exchange it for an OAuth 2.0 access token and make your first call.
- 2
First integration in 15 minutes
Get a sandbox token, create a member, redeem a voucher and receive the signed voucher.redeemed webhook, step by step.
- 3
Sandbox
A separate Clive environment with synthetic data for building and testing integrations.
API reference
One page per resource, generated from the OpenAPI document the API is built from.
Account1 operation
The calling API client.
- GET
/me
- GET
Members5 operations
Members (patients) the partner shares with the clinic, keyed by the partner's own id.
- GET
/members - POST
/members - GET
/members/{id} - and 2 more
- GET
Venues2 operations
The clinic's branches.
- GET
/venues - GET
/venues/{id}
- GET
Appointments4 operations
Bookings at a venue.
- GET
/appointments - POST
/appointments - GET
/appointments/{id} - and 1 more
- GET
Availability2 operations
Bookable slots.
- GET
/venues/{id}/availability - GET
/availability
- GET
Vouchers3 operations
Partner vouchers held by members, and their redemption at a venue.
- GET
/vouchers - GET
/vouchers/{id} - POST
/vouchers/redeem
- GET
Results1 operation
Released lab results, behind the member's consent.
- GET
/members/{id}/results
- GET
Guides
Pagination and idempotency
Cursor pagination, change feeds with updated_since, and Idempotency-Key headers for safe retries.
Rate limits
Per-client request limits on the partner API, the X-RateLimit headers and how to handle 429 responses.
Versioning and deprecation
How the partner API is versioned, what counts as a breaking change, and the six-month deprecation policy.
Errors
The one error envelope every /public/v1 operation uses, the stable error codes to branch on, and the status codes the OpenAPI document declares.
Webhooks
Data and trust
Consent
The consent purposes Clive records and the consent gate that every share of member data with a partner passes.
FHIR R4
The read-only HL7 FHIR R4 API: endpoints, scopes, the consent gate and how each resource is mapped.
Status and TLS
Where to check Clive status and health, and the transport security (TLS) every connection uses.
Resources
Changelog
Every change to the Clive Partner API, its webhooks and FHIR view, newest first, with the deprecations announced under the six-month policy.
OpenAPI document
The OpenAPI 3.1 document the API is built from, for generating a client or importing into Postman or Insomnia.
Support
Something unclear, or a question the docs do not answer? Contact the Clive partnerships team.