API reference
API reference
Every /public/v1 resource and operation with its scope, parameters, request body and responses, generated from the OpenAPI 3.1 document.
Clive Partner API, version 1.0.0: 18 operations across 7 resources. Everything on these pages is generated from the OpenAPI 3.1 document the API is built from, so it always matches what the API serves.
OpenAPI document and Swagger UI
- Download
openapi.json(OpenAPI 3.1) to generate a client or import it into Postman or Insomnia. - Try the API in Swagger UI on the sandbox, served by the API at
GET /public/v1/docs. - The API also serves the document live at
GET /public/v1/openapi.json(no authentication).
Paths are relative to the API host: https://sandbox-api.clivehealth.app for the sandbox, https://api.clivehealth.app for production. All of them start with /public/v1.
Authentication
OAuth 2.0 client credentials. Exchange your client ID and secret at POST /oauth/token for a Bearer token and send it as Authorization: Bearer <token>. Each operation names the scope it needs; the scope table lists them all. Every error is the error envelope; lists are cursor-paginated and every POST carries an Idempotency-Key.
Resources
Account1 operation
The calling API client.
Members5 operations
Members (patients) the partner shares with the clinic, keyed by the partner's own id.
Venues2 operations
The clinic's branches.
Appointments4 operations
Bookings at a venue.
Availability2 operations
Bookable slots.
Vouchers3 operations
Partner vouchers held by members, and their redemption at a venue.
Results1 operation
Released lab results, behind the member's consent.