DodoDentist API 1.0.0

Public REST API for DodoDentist. Authenticate with an API key created in the DodoDentist dashboard: send the base64-encoded key secret with HTTP Basic auth. Each key carries per-resource scopes like patients:read or appointments:write.

Base URL https://api.dododentist.com

apiKey — HTTP Basic auth carrying only the API key secret: Authorization: Basic base64(<key secret>).
accessToken — Operator session token issued by the DodoDentist dashboard: Authorization: Token <access token>.

Download the OpenAPI specification

Appointments

GET`/api/appointments`

List appointments

Lists the appointments of your organization. Requires the appointments:read scope.

Authentication apiKey accessToken

Parameters

Name	In	Type	Description
`clinicId`	query	string
`patientId`	query	string
`startTime`	query	string
`endTime`	query	string
`fields`	query	string	Comma-separated projection of fields to return

Responses

Status	Meaning
`200`	Array of appointments
`401`	Missing or invalid credentials
`403`	API key is missing the `appointments:read` scope
`429`	API key rate limit exceeded
`default`	Error response

POST`/api/appointments`

Create an appointment

Requires the appointments:write scope. Fires the appointment.created webhook.

Authentication apiKey accessToken

Request body application/json

Field	Type	Description
`clinicId` required	string
`patientId`	string
`startTime`	string
`endTime`	string

Responses

Status	Meaning
`200`	The created appointment
`403`	API key is missing the `appointments:write` scope
`default`	Error response

GET`/api/appointments/{appointmentId}`

Get an appointment

Returns a single appointment by id. Appointments belonging to another organization respond 404. Requires the appointments:read scope.

Authentication apiKey accessToken

Parameters

Name	In	Type	Description
`appointmentId` required	path	string

Responses

Status	Meaning
`200`	The appointment
`404`	Not found (or owned by another organization)
`default`	Error response

PUT`/api/appointments/{appointmentId}`

Update an appointment

Requires the appointments:write scope. Fires the appointment.updated webhook.

Authentication apiKey accessToken

Parameters

Name	In	Type	Description
`appointmentId` required	path	string

Request body application/json

Field	Type	Description
`_id`	string
`clinicId`	string
`patientId`	string
`startTime`	string
`endTime`	string
`status`	string REQUESTED \| SCHEDULED \| PATIENT_ARRIVED \| NO_SHOW \| CANCELED
`procedures`	array
`reminders`	array
`lastEditTime`	string

Responses

Status	Meaning
`200`	The updated appointment
`404`	Not found (or owned by another organization)
`default`	Error response

DELETE`/api/appointments/{appointmentId}`

Delete an appointment

Requires the appointments:write scope. Fires the appointment.deleted webhook.

Authentication apiKey accessToken

Parameters

Name	In	Type	Description
`appointmentId` required	path	string

Responses

Status	Meaning
`200`	The deleted appointment
`404`	Not found (or owned by another organization)
`default`	Error response

Clinics

GET`/api/clinics`

List clinics

Lists the clinics of your organization. Requires the clinics:read scope.

Authentication apiKey accessToken

Responses

Status	Meaning
`200`	Array of clinics
`403`	API key is missing the `clinics:read` scope
`default`	Error response

Invoices

GET`/api/invoices`

List invoices

Lists the invoices of your organization. Requires the invoices:read scope.

Authentication apiKey accessToken

Parameters

Name	In	Type	Description
`clinicId`	query	string
`patientId`	query	string

Responses

Status	Meaning
`200`	Array of invoices
`403`	API key is missing the `invoices:read` scope
`default`	Error response

Patients

GET`/api/patients`

List patients

Lists the patients of your clinic. Requires the patients:read scope.

Authentication apiKey accessToken

Parameters

Name	In	Type	Description
`clinicId`	query	string
`email`	query	string
`_ids`	query	string	Comma-separated list of patient ids
`fields`	query	string	Comma-separated projection of fields to return

Responses

Status	Meaning
`200`	Array of patients
`401`	Missing or invalid credentials
`403`	API key is missing the `patients:read` scope
`429`	API key rate limit exceeded
`default`	Error response

POST`/api/patients`

Create a patient

Creates a patient in your clinic. Requires the patients:write scope. Fires the patient.created webhook.

Authentication apiKey accessToken

Request body application/json

Field	Type	Description
`clinicId` required	string
`name`	string
`email`	string
`phone`	string

Responses

Status	Meaning
`200`	The created patient
`403`	API key is missing the `patients:write` scope
`default`	Error response

GET`/api/patients/{patientId}`

Get a patient

Returns a single patient by id. Patients belonging to another organization respond 404. Requires the patients:read scope.

Authentication apiKey accessToken

Parameters

Name	In	Type	Description
`patientId` required	path	string

Responses

Status	Meaning
`200`	The patient
`404`	Not found (or owned by another organization)
`default`	Error response

PUT`/api/patients/{patientId}`

Update a patient

Requires the patients:write scope. Fires the patient.updated webhook.

Authentication apiKey accessToken

Parameters

Name	In	Type	Description
`patientId` required	path	string

Request body application/json

Field	Type	Description
`_id`	string
`clinicId`	string
`name`	string
`email`	string
`phone`	string
`language`	string
`lastEditTime`	string

Responses

Status	Meaning
`200`	The updated patient
`404`	Not found (or owned by another organization)
`default`	Error response

DELETE`/api/patients/{patientId}`

Delete a patient

Requires the patients:write scope. Fires the patient.deleted webhook.

Authentication apiKey accessToken

Parameters

Name	In	Type	Description
`patientId` required	path	string

Responses

Status	Meaning
`200`	The deleted patient
`404`	Not found (or owned by another organization)
`default`	Error response

Payments

GET`/api/payments`

List payments

Lists the payments of your organization. Requires the payments:read scope.

Authentication apiKey accessToken

Parameters

Name	In	Type	Description
`clinicId`	query	string
`patientId`	query	string

Responses

Status	Meaning
`200`	Array of payments
`403`	API key is missing the `payments:read` scope
`default`	Error response

Treatments

GET`/api/treatments`

List treatments

Lists your organization's clinical treatment records. Requires the treatments:read scope.

Authentication apiKey accessToken

Responses

Status	Meaning
`200`	Array of treatments
`403`	API key is missing the `treatments:read` scope
`default`	Error response

Webhook subscriptions

GET`/api/webhooksubscriptions`

List webhook subscriptions

Webhook subscriptions deliver patient.created, patient.updated, patient.deleted, appointment.created, appointment.updated, appointment.deleted, invoice.* and payment.* events to your server as signed POST requests (X-Dododentist-Signature: t=<timestamp>,v1=<hex HMAC-SHA256 of "timestamp.body">). An endpoint failing 20 times in a row is disabled automatically. Subscriptions are managed with an operator access token; the secret is only returned once, on create.

Authentication accessToken

Responses

Status	Meaning
`200`	Array of webhook subscriptions (without secrets)
`default`	Error response

POST`/api/webhooksubscriptions`

Create a webhook subscription

The response includes the signing secret exactly once — store it; it cannot be retrieved again.

Authentication accessToken

Request body application/json

Field	Type	Description
`clinicId` required	string
`url` required	string
`events`	array	Empty array subscribes to all events

Responses

Status	Meaning
`200`	The created subscription, including its secret
`default`	Error response

PUT`/api/webhooksubscriptions/{webhookSubscriptionId}`

Update a webhook subscription

url, events and active are editable; the secret and clinic are immutable. Re-enabling an auto-disabled endpoint is done by setting active back to true.

Authentication accessToken

Parameters

Name	In	Type	Description
`webhookSubscriptionId` required	path	string

Responses

Status	Meaning
`200`	The updated subscription (without secret)
`default`	Error response

DELETE`/api/webhooksubscriptions/{webhookSubscriptionId}`

Delete a webhook subscription

Authentication accessToken

Parameters

Name	In	Type	Description
`webhookSubscriptionId` required	path	string

Responses

Status	Meaning
`200`	Deleted
`default`	Error response

DodoDentist API 1.0.0

Appointments

GET/api/appointments

Parameters

Responses

POST/api/appointments

Request body application/json

Responses

GET/api/appointments/{appointmentId}

Parameters

Responses

PUT/api/appointments/{appointmentId}

Parameters

Request body application/json

Responses

DELETE/api/appointments/{appointmentId}

Parameters

Responses

Clinics

GET/api/clinics

Responses

Invoices

GET/api/invoices

Parameters

Responses

Patients

GET/api/patients

Parameters

Responses

POST/api/patients

Request body application/json

Responses

GET/api/patients/{patientId}

Parameters

Responses

PUT/api/patients/{patientId}

Parameters

Request body application/json

Responses

DELETE/api/patients/{patientId}

Parameters

Responses

Payments

GET/api/payments

Parameters

Responses

Treatments

GET/api/treatments

Responses

Webhook subscriptions

GET/api/webhooksubscriptions

Responses

POST/api/webhooksubscriptions

Request body application/json

Responses

PUT/api/webhooksubscriptions/{webhookSubscriptionId}

Parameters

Responses

DELETE/api/webhooksubscriptions/{webhookSubscriptionId}

Parameters

Responses

GET`/api/appointments`

POST`/api/appointments`

GET`/api/appointments/{appointmentId}`

PUT`/api/appointments/{appointmentId}`

DELETE`/api/appointments/{appointmentId}`

GET`/api/clinics`

GET`/api/invoices`

GET`/api/patients`

POST`/api/patients`

GET`/api/patients/{patientId}`

PUT`/api/patients/{patientId}`

DELETE`/api/patients/{patientId}`

GET`/api/payments`

GET`/api/treatments`

GET`/api/webhooksubscriptions`

POST`/api/webhooksubscriptions`

PUT`/api/webhooksubscriptions/{webhookSubscriptionId}`

DELETE`/api/webhooksubscriptions/{webhookSubscriptionId}`