How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Cliniko Patients API

The people who book in for appointments.

Cliniko Patients API is one of 7 APIs that Cliniko publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Patients. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.{shard}.cliniko.com/v1.

6 operations 4 paths 6 schemas 2 GET1 PATCH3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.au1.cliniko.com/v1
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Cliniko Patients API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication. The API key is the username and the password is left empty (curl: -u APIKEY:). The shard suffix on the key selects the base host.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 2 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Patients 6

The people who book in for appointments.

GET
/patients
Get patients
listPatients 4 params → 200401429
POST
/patients
Create patient
createPatient 1 param body → 201401422
GET
/patients/{id}
Get patient
getPatient 2 params → 200401404
PATCH
/patients/{id}
Update patient
updatePatient 2 params body → 200401404422
POST
/patients/{id}/archive
Archive patient
archivePatient 2 params → 200401404
POST
/patients/{id}/unarchive
Unarchive patient
unarchivePatient 2 params → 200401404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Patient (35 properties), PatientInput (13 properties), Links (3 properties), Error (2 properties). Each schema is shown below with its type and property counts.

Links
object
HAL-style pagination and self links.
3 properties
Patient
object
35 properties
PatientPhoneNumber
object
2 properties
Error
object
2 properties
PatientInput
object
13 properties 2 required
Reference
object
A link to a related resource.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cliniko-patients-api-openapi.yml Raw ↑

Other APIs Cliniko publishes across the network.

Cliniko Appointment Types API
Cliniko Appointments API
Cliniko Businesses API
Cliniko Invoices API
Cliniko Practitioners API
Cliniko Treatment Notes API
Where this information came from

This is an independent, third-party profile of Cliniko Patients API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.