# Carebit healthcare API reference

REST API endpoints for private integrations that the customer organisation deploys, controls and operates.

You can use AI agents as part of a private integration that your organisation deploys, controls and operates. Do not give custom-integration credentials to third-party products.

## OAuth

- [POST /oauth/revoke](/api/oauth/revoke?format=md): Revoke an access or refresh token
- [POST /oauth/token](/api/oauth/token?format=md): Create an access token
- [GET /v1/token](/api/oauth/retrieve?format=md): Get the access token used on this request

## Agenda

- [GET /v1/clinician_agenda](/api/clinician-agenda/retrieve?format=md): Get a Clinician's diary

## Availability Periods

- [POST /v1/availability_periods](/api/availability-periods/create?format=md): Create an availability or unavailability period
- [PATCH /v1/availability_periods/:id](/api/availability-periods/update?format=md): Update an availability or unavailability period
- [DELETE /v1/availability_periods/:id](/api/availability-periods/delete?format=md): Delete an availability or unavailability period

## Availability Slots

- [GET /v1/availability_slots](/api/availability-slots/list?format=md): List slots that a Clinician can be booked into
- [GET /v1/next_availability_slot](/api/next-availability-slot/retrieve?format=md): Get the next slot that a Clinician can be booked into

## Booking Forms

- [GET /v1/booking_forms](/api/booking-forms/list?format=md): List Booking Forms
- [POST /v1/booking_forms](/api/booking-forms/create?format=md): Create a Booking Form with a file
- [GET /v1/booking_forms/:id](/api/booking-forms/retrieve?format=md): Get a Booking Form
- [PATCH /v1/booking_forms/:id](/api/booking-forms/update?format=md): Update a Booking Form

## Bookings

- [GET /v1/bookings](/api/bookings/list?format=md): List Bookings
- [POST /v1/bookings](/api/bookings/create?format=md): Create a Booking
- [GET /v1/bookings/:id](/api/bookings/retrieve?format=md): Get a Booking
- [PATCH /v1/bookings/:id](/api/bookings/update?format=md): Update a Booking
- [POST /v1/bookings/:id/cancellations](/api/booking-cancellations/create?format=md): Cancel a Booking

## Clinicians

- [GET /v1/clinicians](/api/clinicians/list?format=md): List the Organization's Clinicians
- [GET /v1/clinicians/:id](/api/clinicians/retrieve?format=md): Get a Clinician

## Credit Notes

- [GET /v1/credit_notes](/api/credit-notes/list?format=md): List CreditNotes
- [POST /v1/credit_notes](/api/credit-notes/create?format=md): Create a CreditNote
- [GET /v1/credit_notes/:id](/api/credit-notes/retrieve?format=md): Retrieve a CreditNote
- [PATCH /v1/credit_notes/:id](/api/credit-notes/update?format=md): Update a CreditNote
- [DELETE /v1/credit_notes/:id](/api/credit-notes/delete?format=md): Delete a CreditNote

## Digital Form Responses

- [GET /v1/digital_form_responses](/api/digital-form-responses/list?format=md): List a Patient's DigitalFormResponses
- [POST /v1/digital_form_responses](/api/digital-form-responses/create?format=md): Create and send a DigitalFormResponse
- [GET /v1/digital_form_responses/:id](/api/digital-form-responses/retrieve?format=md): Retrieve a DigitalFormResponse

## Digital Forms

- [GET /v1/digital_forms](/api/digital-forms/list?format=md): List DigitalForms
- [POST /v1/digital_forms](/api/digital-forms/create?format=md): Create a DigitalForm
- [GET /v1/digital_forms/:id](/api/digital-forms/retrieve?format=md): Retrieve a DigitalForm

## Expirable Files

- [GET /v1/expirable_files](/api/expirable-files/list?format=md): List ExpirableFiles
- [GET /v1/expirable_files/:id](/api/expirable-files/retrieve?format=md): Retrieve an ExpirableFile

## Human Tasks

- [GET /v1/human_tasks](/api/human-tasks/list?format=md): List HumanTasks
- [POST /v1/human_tasks](/api/human-tasks/create?format=md): Create a HumanTask
- [GET /v1/human_tasks/:id](/api/human-tasks/retrieve?format=md): Get a HumanTask
- [PATCH /v1/human_tasks/:id](/api/human-tasks/update?format=md): Update a HumanTask
- [POST /v1/human_tasks/:id/comments](/api/human-task-comments/create?format=md): Add a Comment to a HumanTask

## Invoices

- [GET /v1/invoices](/api/invoices/list?format=md): List Invoices
- [POST /v1/invoices](/api/invoices/create?format=md): Create an Invoice
- [GET /v1/invoices/:id](/api/invoices/retrieve?format=md): Retrieve an Invoice

## Leads

Carebit Pro is required.

- [GET /v1/lead_form_responses](/api/lead-form-responses/list?format=md): List a Lead's form responses
- [GET /v1/lead_form_responses/:id](/api/lead-form-responses/retrieve?format=md): Get a Lead's form response
- [GET /v1/lead_pipelines](/api/lead-pipelines/list?format=md): List Lead pipelines and stages
- [GET /v1/leads](/api/leads/list?format=md): List Leads
- [POST /v1/leads](/api/leads/create?format=md): Create a Lead
- [GET /v1/leads/:id](/api/leads/retrieve?format=md): Get a Lead
- [PATCH /v1/leads/:id](/api/leads/update?format=md): Update a Lead

## Letters

- [POST /v1/letter_batches](/api/letter-batches/create?format=md): Create up to 100 Letters in one request
- [GET /v1/letters](/api/letters/list?format=md): List Letters
- [POST /v1/letters](/api/letters/create?format=md): Create a Letter with a file
- [GET /v1/letters/:id](/api/letters/retrieve?format=md): Get a Letter

## Lists

- [GET /v1/lists](/api/lists/list?format=md): List Lists
- [POST /v1/lists](/api/lists/create?format=md): Create a List
- [GET /v1/lists/:id](/api/lists/retrieve?format=md): Get a List
- [PATCH /v1/lists/:id](/api/lists/update?format=md): Update a List
- [DELETE /v1/lists/:id](/api/lists/delete?format=md): Delete a List
- [GET /v1/lists/:list_id/members](/api/list-members/list?format=md): List members of a List
- [POST /v1/lists/:list_id/members](/api/list-members/create?format=md): Add a member to a List
- [DELETE /v1/lists/:list_id/members/:id](/api/list-members/delete?format=md): Remove a member from a List

## Locations

- [GET /v1/locations](/api/locations/list?format=md): List Locations
- [GET /v1/locations/:id](/api/locations/retrieve?format=md): Get a Location

## Notes

- [GET /v1/notes](/api/notes/list?format=md): List Notes
- [POST /v1/notes](/api/notes/create?format=md): Create a Note
- [GET /v1/notes/:id](/api/notes/retrieve?format=md): Get a Note
- [PATCH /v1/notes/:id](/api/notes/update?format=md): Update an API-created Note

## Organization

- [GET /v1/organization](/api/organization/retrieve?format=md): Get the Organization for this access token
- [GET /v1/organizations](/api/organizations/search?format=md): Search Organizations

## Patient Connection Requests

- [GET /v1/patient_connection_requests](/api/patient-connection-requests/list?format=md): List PatientConnectionRequests
- [GET /v1/patient_connection_requests/:id](/api/patient-connection-requests/retrieve?format=md): Get a PatientConnectionRequest
- [POST /v1/patient_connection_requests/:id/actions](/api/patient-connection-request-actions/create?format=md): Action a PatientConnectionRequest

## Patient Connections

- [GET /v1/patients/:patient_id/connections](/api/patient-connections/list?format=md): List a Patient's unlocked PatientConnections
- [POST /v1/patients/:patient_id/connections](/api/patient-connections/create?format=md): Create a PatientConnection
- [GET /v1/patients/:patient_id/connections/:id](/api/patient-connections/retrieve?format=md): Get an unlocked PatientConnection
- [PATCH /v1/patients/:patient_id/connections/:id](/api/patient-connections/update?format=md): Update this Organization's PatientConnection

## Patients

- [GET /v1/patients](/api/patients/list?format=md): List Patients connected to the Organization
- [POST /v1/patients](/api/patients/create?format=md): Create or find a Patient
- [GET /v1/patients/:id](/api/patients/retrieve?format=md): Get a Patient
- [PATCH /v1/patients/:id](/api/patients/update?format=md): Update a Patient

## Payment Methods

- [GET /v1/patients/:id/payment_methods](/api/payment-methods/list?format=md): List a Patient's PaymentMethods

## Payments

- [GET /v1/payments](/api/payments/list?format=md): List Payments
- [POST /v1/payments](/api/payments/create?format=md): Create a Payment
- [POST /v1/payments/:id/refunds](/api/refunds/create?format=md): Create a Refund

## Payors

- [GET /v1/alternative_payors](/api/alternative-payors/list?format=md): List Alternative Payors
- [GET /v1/alternative_payors/:id](/api/alternative-payors/retrieve?format=md): Get an Alternative Payor
- [GET /v1/insurance_companies](/api/insurance-companies/list?format=md): List Insurance Companies
- [GET /v1/insurance_companies/:id](/api/insurance-companies/retrieve?format=md): Get an Insurance Company
- [GET /v1/patients/:patient_id/payors](/api/payors/list?format=md): List a Patient's Payors
- [POST /v1/patients/:patient_id/payors](/api/payors/create?format=md): Create a Patient Payor
- [GET /v1/patients/:patient_id/payors/:id](/api/payors/retrieve?format=md): Get a Patient Payor
- [PATCH /v1/patients/:patient_id/payors/:id](/api/payors/update?format=md): Update a Patient Payor

## Photos

- [GET /v1/photos](/api/photos/list?format=md): List Photos
- [POST /v1/photos](/api/photos/create?format=md): Create a Photo with a file
- [GET /v1/photos/:id](/api/photos/retrieve?format=md): Get a Photo
- [PATCH /v1/photos/:id](/api/photos/update?format=md): Update a Photo

## Quotes

- [POST /v1/quotes](/api/quotes/create?format=md): Create a Quote

## Recall Programmes

- [GET /v1/recall_programmes](/api/recall-programmes/list?format=md): List RecallProgrammes
- [GET /v1/recall_programmes/:id](/api/recall-programmes/retrieve?format=md): Get a RecallProgramme

## Remote File Import Batches

- [GET /v1/remote_file_import_batches/:id](/api/remote-file-import-batches/retrieve?format=md): Get a remote file import batch

## Reports

- [POST /v1/reports](/api/reports/create?format=md): Create a report

## Services

- [POST /v1/service_variants](/api/service-variants/create?format=md): Create a ServiceVariant
- [PATCH /v1/service_variants/:id](/api/service-variants/update?format=md): Update a ServiceVariant
- [GET /v1/services](/api/services/list?format=md): List the Organization's Services
- [POST /v1/services](/api/services/create?format=md): Create a Service
- [GET /v1/services/:id](/api/services/retrieve?format=md): Get a Service
- [PATCH /v1/services/:id](/api/services/update?format=md): Update a Service

## Staff Members

- [GET /v1/staff_members](/api/staff-members/list?format=md): List the Organization's StaffMembers
- [GET /v1/staff_members/:id](/api/staff-members/retrieve?format=md): Get a StaffMember

## Test Results

- [POST /v1/test_result_batches](/api/test-result-batches/create?format=md): Create up to 100 Test Results in one request
- [GET /v1/test_results](/api/test-results/list?format=md): List Test Results
- [POST /v1/test_results](/api/test-results/create?format=md): Create a Test Result
- [GET /v1/test_results/:id](/api/test-results/retrieve?format=md): Get a Test Result

## Transmissions

- [GET /v1/transmissions](/api/transmissions/list?format=md): List Transmissions