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

Dental Services

Operations

Retrieve all dental services

Request

Security
bearer
Query
titlestring

The title of the Dental Service

Example: title=Teeth Whitening
pagenumber>= 0

Page number (0-based)

Default 0
Example: page=0
pageSizenumber[ 1 .. 100 ]

Number of items per page

Default 10
Example: pageSize=10
sortBy[0][field]string

First sort field

Enum"id""title""createdAt""updatedAt"
sortBy[0][dir]string

First sort direction

Enum"asc""desc"
sortBy[1][field]string

Second sort field

Enum"id""title""createdAt""updatedAt"
sortBy[1][dir]string

Second sort direction

Enum"asc""desc"
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/dental-service?title=Teeth+Whitening&page=0&pageSize=10&sortBy%5B0%5D%5Bfield%5D=id&sortBy%5B0%5D%5Bdir%5D=asc&sortBy%5B1%5D%5Bfield%5D=id&sortBy%5B1%5D%5Bdir%5D=asc' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of dental services retrieved successfully.

Bodyapplication/json
dataArray of objects(DentalServiceDto)required

Array of Dental Services

data[].​titlestringrequired

The title of the dental service

Example: "Teeth Whitening"
data[].​isEnabledboolean

Indicates whether the dental service is enabled

Example: true
data[].​idnumberrequired

The ID of the dental service

Example: 123
data[].​createdAtstringrequired

The date the dental service was created

Example: "2021-07-01T00:00:00.000Z"
data[].​updatedAtstringrequired

The date the dental service was last updated

Example: "2021-07-01T00:00:00.000Z"
metaobjectrequired
meta.​pagenumberrequired

Current page number (0-based)

Example: 0
meta.​pageSizenumberrequired

Number of items per page

Example: 10
meta.​totalnumberrequired

Total number of items

Example: 150
meta.​totalPagesnumberrequired

Total number of pages

Example: 15
meta.​hasNextbooleanrequired

Whether there is a next page

Example: true
meta.​hasPreviousbooleanrequired

Whether there is a previous page

Example: false
Response
application/json
{
  "data": [
    { … }
  ],
  "meta": {
    "page": 0,
    "pageSize": 10,
    "total": 150,
    "totalPages": 15,
    "hasNext": true,
    "hasPrevious": false
  }
}

Create a new dental service

Request

Security
bearer
Bodyapplication/jsonrequired
titlestringrequired

The title of the dental service

Example: "Teeth Whitening"
isEnabledboolean

Indicates whether the dental service is enabled

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

Responses

Dental service created successfully.

Bodyapplication/json
titlestringrequired

The title of the dental service

Example: "Teeth Whitening"
isEnabledboolean

Indicates whether the dental service is enabled

Example: true
idnumberrequired

The ID of the dental service

Example: 123
createdAtstringrequired

The date the dental service was created

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

The date the dental service was last updated

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

Update an existing dental service

Request

Security
bearer
Path
dentalServiceIdnumberrequired
Bodyapplication/jsonrequired
titlestringrequired

The title of the dental service

Example: "Teeth Whitening"
isEnabledboolean

Indicates whether the dental service is enabled

Example: true
idnumberrequired

The ID of the dental service to be updated

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

Responses

Dental service updated successfully.

Bodyapplication/json
titlestringrequired

The title of the dental service

Example: "Teeth Whitening"
isEnabledboolean

Indicates whether the dental service is enabled

Example: true
idnumberrequired

The ID of the dental service to be updated

Example: 123
Response
application/json
{
  "title": "Teeth Whitening",
  "isEnabled": true,
  "id": 123
}

Delete a dental service

Request

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

Responses

Dental service deleted successfully.

Response
No content

Organizations

Operations

Practice Management Systems

Operations

Stroage

Operations

Site Assistants

Operations

Sites

Operations

Codes

Operations

Periomeasure

Operations

Availability

Operations

Users

Operations

Billing Information

Operations