Carebit API
API reference
Every endpoint below returns a flat JSON object. Nested resources are linked from a links map so you can traverse without a second query.
Use this healthcare API reference to connect systems that your organisation deploys, controls and operates, including AI agents that your organisation controls. Do not give custom-integration credentials to third-party products.
OAuth
Create, inspect, and revoke OAuth 2.0 access tokens.
Agenda
A Clinician's diary, including Bookings, availability, and unavailability.
Availability Periods
Set when Clinicians can and cannot be booked, including repeating schedules.
Availability Slots
Find slots that a Clinician can be booked into.
Booking Forms
Booking forms generated for a Patient.
Bookings
Appointments booked for Patients, including recall Bookings.
Clinicians
Clinicians enabled in the Organization.
Credit Notes
CreditNotes and writeoffs applied to Invoices and Patients.
Digital Form Responses
Patient responses to DigitalForms.
Digital Forms
Forms and consent requests that Patients can complete.
Expirable Files
Temporary files created by asynchronous API requests.
Human Tasks
Tasks assigned to StaffMembers to complete.
Invoices
Invoices associated with Bookings and Patients.
Leads
Patient enquiries and referrals received by the Organization.
Letters
Letters written or received on behalf of a Patient.
Lists
Lists and the Patients who belong to them.
- get
/v1/listsList Lists - post
/v1/listsCreate a List - get
/v1/lists/:idGet a List - patch
/v1/lists/:idUpdate a List - delete
/v1/lists/:idDelete a List - get
/v1/lists/:list_id/membersList members of a List - post
/v1/lists/:list_id/membersAdd a member to a List - delete
/v1/lists/:list_id/members/:idRemove a member from a List
Locations
Locations where Bookings can take place.
Notes
Free-form Notes attached to Patients and Bookings.
Organization
The Organization connected to the access token.
Patient Connection Requests
Audited requests for an Organization to connect an existing Patient, create a separate Patient, or deny the request. There is no separate PatientConnectionRequest scope: list and retrieve use `patients.read`, and act uses `patients.create`.
Patient Connections
Unlocked registrations between a Patient and an Organization, including GP practices.
- get
/v1/patients/:patient_id/connectionsList a Patient's unlocked PatientConnections - post
/v1/patients/:patient_id/connectionsCreate a PatientConnection - get
/v1/patients/:patient_id/connections/:idGet an unlocked PatientConnection - patch
/v1/patients/:patient_id/connections/:idUpdate this Organization's PatientConnection
Patients
Patients with an active connection to the Organization.
Payment Methods
Stored card PaymentMethods for Patients with an active connection to the Organization.
Payments
Payments collected for Invoices and Patients.
Payors
The people and organizations responsible for a Patient's charges.
- get
/v1/alternative_payorsList Alternative Payors - get
/v1/alternative_payors/:idGet an Alternative Payor - get
/v1/insurance_companiesList Insurance Companies - get
/v1/insurance_companies/:idGet an Insurance Company - get
/v1/patients/:patient_id/payorsList a Patient's Payors - post
/v1/patients/:patient_id/payorsCreate a Patient Payor - get
/v1/patients/:patient_id/payors/:idGet a Patient Payor - patch
/v1/patients/:patient_id/payors/:idUpdate a Patient Payor
Photos
Photos stored on a Patient's record.
Quotes
Quotes issued to Patients and AlternativePayors before conversion to Invoices.
Recall Programmes
Recall programmes that enrol Patients for follow-up Bookings.
Remote File Import Batches
The progress of files being imported in the background.
Reports
Reports created asynchronously by Carebit.
Services
The Services offered by the Organization and the ServiceVariants that can be booked.
Staff Members
Staff members in the Organization who can be assigned HumanTasks.
Test Results
Structured or file-based Test Results.
Transmissions
Delivery logs for messages sent about Patients, Documents, Invoices, Quotes, and Bookings.