API reference

Account

The calling API client. 1 operation under /public/v1, with parameters, request bodies and example responses.

Paths are relative to the API host: https://sandbox-api.clivehealth.app for the sandbox, https://api.clivehealth.app for production. Send Authorization: Bearer <token> on every request (Getting started).

Operations

GET/public/v1/meThe calling API client

The calling API client

GET/public/v1/me

Any valid access tokenOperation getMe

Checks a token: the client, its clinic and the scopes the token carries. Any valid token may call it.

Responses

200The client.Returns ApiClientInfo.

getMe 200 response
Field	Type	Description
`client_id`required	`string`
`clinic_id`required	`string (uuid)`
`scopes`required	`array of "members:read" \| "members:write" \| "consents:read" \| "consents:write" \| "appointments:read" \| "appointments:write" \| "availability:read" \| "venues:read" \| "venues:write" \| "vouchers:read" \| "vouchers:write" \| "results:read" \| "leads:read" \| "leads:write" \| "cases:read" \| "cases:write" \| "webhooks:manage"`

Response 200JSON

{
  "client_id": "cli_9f3a2b1c",
  "clinic_id": "3f6b8d0a-2c4e-4f1a-9b3d-5e7f9a1c3e5b",
  "scopes": [
    "members:read"
  ]
}

getMe error responses
Status	Meaning
400	Malformed request or invalid cursor.
401	Missing, invalid or expired access token, or the API client was revoked (INVALID_TOKEN).
422	Validation failed (VALIDATION_ERROR).
429	Per-client rate limit exceeded (RATE_LIMITED).
500	Unexpected error (INTERNAL_ERROR).

Every error body is the error envelope; branch on its code.