Skip to content

HeyDonto API Documentation (1.0)

API documentation for HeyDonto API

Powered by HeyDonto
Overview
Languages
Servers
Mock server

https://docs.heydonto.com/_mock/apis/heydonto/openapi/

Sandbox

https://api-staging.heydonto.com/

Production

https://api.heydonto.com/

Site Appointment Types

Operations

Appointment Type

Operations

Brands

Operations

Dental Practices

Operations

Retrieve all dental practices

Request

Security
bearer
curl -i -X GET \
  https://docs.heydonto.com/_mock/apis/heydonto/openapi/dental-practices \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of dental practices retrieved successfully.

Bodyapplication/jsonArray [
titlestringrequired

The title of the dental practice

Example: "Downtown Dental Clinic"
isEnabledboolean

Indicates if the dental practice is enabled

Example: true
idnumberrequired

The ID of the dental practice to be updated

Example: 123
createdAtstringrequired

The date the dental practice was created

Example: "2021-07-01T00:00:00.000Z"
updatedAtstringrequired

The date the dental practice was last updated

Example: "2021-07-01T00:00:00.000Z"
]
Response
application/json
[
  {
    "title": "Downtown Dental Clinic",
    "isEnabled": true,
    "id": 123,
    "createdAt": "2021-07-01T00:00:00.000Z",
    "updatedAt": "2021-07-01T00:00:00.000Z"
  }
]

Create a new dental practice

Request

Security
bearer
Bodyapplication/jsonrequired
titlestringrequired

The title of the dental practice

Example: "Downtown Dental Clinic"
isEnabledboolean

Indicates if the dental practice is enabled

Example: true
curl -i -X POST \
  https://docs.heydonto.com/_mock/apis/heydonto/openapi/dental-practices \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Downtown Dental Clinic",
    "isEnabled": true
  }'

Responses

Dental practice created successfully.

Bodyapplication/json
titlestringrequired

The title of the dental practice

Example: "Downtown Dental Clinic"
isEnabledboolean

Indicates if the dental practice is enabled

Example: true
idnumberrequired

The ID of the dental practice to be updated

Example: 123
createdAtstringrequired

The date the dental practice was created

Example: "2021-07-01T00:00:00.000Z"
updatedAtstringrequired

The date the dental practice was last updated

Example: "2021-07-01T00:00:00.000Z"
Response
application/json
{
  "title": "Downtown Dental Clinic",
  "isEnabled": true,
  "id": 123,
  "createdAt": "2021-07-01T00:00:00.000Z",
  "updatedAt": "2021-07-01T00:00:00.000Z"
}

Update an existing dental practice

Request

Security
bearer
Path
dentalPracticeIdnumberrequired
Bodyapplication/jsonrequired
titlestringrequired

The title of the dental practice

Example: "Downtown Dental Clinic"
isEnabledboolean

Indicates if the dental practice is enabled

Example: true
idnumberrequired

The ID of the dental practice to be updated

Example: 123
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/dental-practices/{dentalPracticeId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "Downtown Dental Clinic",
    "isEnabled": true,
    "id": 123
  }'

Responses

Dental practice updated successfully.

Bodyapplication/json
titlestringrequired

The title of the dental practice

Example: "Downtown Dental Clinic"
isEnabledboolean

Indicates if the dental practice is enabled

Example: true
idnumberrequired

The ID of the dental practice to be updated

Example: 123
createdAtstringrequired

The date the dental practice was created

Example: "2021-07-01T00:00:00.000Z"
updatedAtstringrequired

The date the dental practice was last updated

Example: "2021-07-01T00:00:00.000Z"
Response
application/json
{
  "title": "Downtown Dental Clinic",
  "isEnabled": true,
  "id": 123,
  "createdAt": "2021-07-01T00:00:00.000Z",
  "updatedAt": "2021-07-01T00:00:00.000Z"
}

Delete a dental practice

Request

Security
bearer
Path
dentalPracticeIdnumberrequired
curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/dental-practices/{dentalPracticeId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Dental practice deleted successfully.

Response
No content

Dental Services

Operations

Organizations

Operations

Practice Management Systems

Operations

Sites

Operations

Codes

Operations

Site Assistants

Operations

Periomeasure

Operations

Availability

Operations

Users

Operations

Billing Information

Operations