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

Organizations

Operations

Practice Management Systems

Operations

Sites

Operations

Retrieve all sites based on the user role

Request

Security
bearer
Query
clientAccountIdArray of stringsrequired
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site?clientAccountId=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

List of sites retrieved successfully.

Bodyapplication/jsonArray [
namestringrequired

The name of the site

Example: "Downtown Clinic"
addressobjectrequired

The address of the site

Example: {"street":"123 Main St","city":"New York","zipCode":"10001"}
googlePlaceIdstringrequired

The Google Place ID of the site

Example: "ChIJN1t_tDeuEmsRUsoyG83frY4"
clientAccountIdnumber

The ID of the client Account the site belongs to

Example: 1
organizationIdnumber

The ID of the organization the site belongs to

Example: 1
brandIdnumber

The ID of the brand the site belongs to

Example: 2
phoneNumberstring

The phone number of the site

Example: "+1-555-555-5555"
websitestring

The website of the site

Example: "https://www.downtownclinic.com"
anyDeskIpstring

The AnyDesk IP of the site for remote access

Example: "192.168.1.1"
practiceManagementSystemIdnumberrequired

The practice management system ID for the site

Example: 123
isEnabledboolean

Indicates if the site is enabled

Example: true
siteManagerUserIdnumber

The ID of the decision-maker user

Example: 45
dentalServiceIdsArray of stringsrequired

Array of dental service IDs associated with the site

Example: [1,2,3]
dentalPracticeIdsArray of stringsrequired

Array of dental practice IDs associated with the site

Example: [10,11,12]
cloudUserNamestring

The cloud based username for the site

Example: "cloud-user"
cloudUserPasswordstring

The cloud based user password for the site

Example: "cloud-user-password"
cloudOrganizationNamestring

The cloud based user password for the site

Example: "cloud-organization-name"
cloudLoginUrlstring

The cloud based login url for the site

Example: "https://cloud-login-url.com"
createdAtstringrequired

The date and time the site was created

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

The date and time the site was last updated

Example: "2021-08-01T00:00:00.000Z"
]
Response
application/json
[
  {
    "name": "Downtown Clinic",
    "address": { … },
    "googlePlaceId": "ChIJN1t_tDeuEmsRUsoyG83frY4",
    "clientAccountId": 1,
    "organizationId": 1,
    "brandId": 2,
    "phoneNumber": "+1-555-555-5555",
    "website": "https://www.downtownclinic.com",
    "anyDeskIp": "192.168.1.1",
    "practiceManagementSystemId": 123,
    "isEnabled": true,
    "siteManagerUserId": 45,
    "dentalServiceIds": [ … ],
    "dentalPracticeIds": [ … ],
    "cloudUserName": "cloud-user",
    "cloudUserPassword": "cloud-user-password",
    "cloudOrganizationName": "cloud-organization-name",
    "cloudLoginUrl": "https://cloud-login-url.com",
    "createdAt": "2021-08-01T00:00:00.000Z",
    "updatedAt": "2021-08-01T00:00:00.000Z"
  }
]

Create a new site

Request

Security
bearer
Bodyapplication/jsonrequired
namestringrequired

The name of the site

Example: "Downtown Clinic"
addressobjectrequired

The address of the site

Example: {"street":"123 Main St","city":"New York","zipCode":"10001"}
googlePlaceIdstringrequired

The Google Place ID of the site

Example: "ChIJN1t_tDeuEmsRUsoyG83frY4"
clientAccountIdnumber

The ID of the client Account the site belongs to

Example: 1
organizationIdnumber

The ID of the organization the site belongs to

Example: 1
brandIdnumber

The ID of the brand the site belongs to

Example: 2
phoneNumberstring

The phone number of the site

Example: "+1-555-555-5555"
websitestring

The website of the site

Example: "https://www.downtownclinic.com"
anyDeskIpstring

The AnyDesk IP of the site for remote access

Example: "192.168.1.1"
practiceManagementSystemIdnumberrequired

The practice management system ID for the site

Example: 123
isEnabledboolean

Indicates if the site is enabled

Example: true
siteManagerUserIdnumber

The ID of the decision-maker user

Example: 45
dentalServiceIdsArray of stringsrequired

Array of dental service IDs associated with the site

Example: [1,2,3]
dentalPracticeIdsArray of stringsrequired

Array of dental practice IDs associated with the site

Example: [10,11,12]
cloudUserNamestring

The cloud based username for the site

Example: "cloud-user"
cloudUserPasswordstring

The cloud based user password for the site

Example: "cloud-user-password"
cloudOrganizationNamestring

The cloud based user password for the site

Example: "cloud-organization-name"
cloudLoginUrlstring

The cloud based login url for the site

Example: "https://cloud-login-url.com"
curl -i -X POST \
  https://docs.heydonto.com/_mock/apis/heydonto/openapi/site \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Downtown Clinic",
    "address": {
      "street": "123 Main St",
      "city": "New York",
      "zipCode": "10001"
    },
    "googlePlaceId": "ChIJN1t_tDeuEmsRUsoyG83frY4",
    "clientAccountId": 1,
    "organizationId": 1,
    "brandId": 2,
    "phoneNumber": "+1-555-555-5555",
    "website": "https://www.downtownclinic.com",
    "anyDeskIp": "192.168.1.1",
    "practiceManagementSystemId": 123,
    "isEnabled": true,
    "siteManagerUserId": 45,
    "dentalServiceIds": [
      1,
      2,
      3
    ],
    "dentalPracticeIds": [
      10,
      11,
      12
    ],
    "cloudUserName": "cloud-user",
    "cloudUserPassword": "cloud-user-password",
    "cloudOrganizationName": "cloud-organization-name",
    "cloudLoginUrl": "https://cloud-login-url.com"
  }'

Responses

Site created successfully.

Bodyapplication/json
namestringrequired

The name of the site

Example: "Downtown Clinic"
addressobjectrequired

The address of the site

Example: {"street":"123 Main St","city":"New York","zipCode":"10001"}
googlePlaceIdstringrequired

The Google Place ID of the site

Example: "ChIJN1t_tDeuEmsRUsoyG83frY4"
clientAccountIdnumber

The ID of the client Account the site belongs to

Example: 1
organizationIdnumber

The ID of the organization the site belongs to

Example: 1
brandIdnumber

The ID of the brand the site belongs to

Example: 2
phoneNumberstring

The phone number of the site

Example: "+1-555-555-5555"
websitestring

The website of the site

Example: "https://www.downtownclinic.com"
anyDeskIpstring

The AnyDesk IP of the site for remote access

Example: "192.168.1.1"
practiceManagementSystemIdnumberrequired

The practice management system ID for the site

Example: 123
isEnabledboolean

Indicates if the site is enabled

Example: true
siteManagerUserIdnumber

The ID of the decision-maker user

Example: 45
dentalServiceIdsArray of stringsrequired

Array of dental service IDs associated with the site

Example: [1,2,3]
dentalPracticeIdsArray of stringsrequired

Array of dental practice IDs associated with the site

Example: [10,11,12]
cloudUserNamestring

The cloud based username for the site

Example: "cloud-user"
cloudUserPasswordstring

The cloud based user password for the site

Example: "cloud-user-password"
cloudOrganizationNamestring

The cloud based user password for the site

Example: "cloud-organization-name"
cloudLoginUrlstring

The cloud based login url for the site

Example: "https://cloud-login-url.com"
createdAtstringrequired

The date and time the site was created

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

The date and time the site was last updated

Example: "2021-08-01T00:00:00.000Z"
Response
application/json
{
  "name": "Downtown Clinic",
  "address": {
    "street": "123 Main St",
    "city": "New York",
    "zipCode": "10001"
  },
  "googlePlaceId": "ChIJN1t_tDeuEmsRUsoyG83frY4",
  "clientAccountId": 1,
  "organizationId": 1,
  "brandId": 2,
  "phoneNumber": "+1-555-555-5555",
  "website": "https://www.downtownclinic.com",
  "anyDeskIp": "192.168.1.1",
  "practiceManagementSystemId": 123,
  "isEnabled": true,
  "siteManagerUserId": 45,
  "dentalServiceIds": [
    1,
    2,
    3
  ],
  "dentalPracticeIds": [
    10,
    11,
    12
  ],
  "cloudUserName": "cloud-user",
  "cloudUserPassword": "cloud-user-password",
  "cloudOrganizationName": "cloud-organization-name",
  "cloudLoginUrl": "https://cloud-login-url.com",
  "createdAt": "2021-08-01T00:00:00.000Z",
  "updatedAt": "2021-08-01T00:00:00.000Z"
}

Retrieve active site analytics (Admin only)

Request

Returns sites grouped by clientAccountId with optional date filters.

Security
bearer
Query
startDatestring(date-time)

Filter sites by start date (inclusive). Format: YYYY-MM-DD

Example: startDate=2023-01-01
endDatestring(date-time)

Filter sites by end date (inclusive). Format: YYYY-MM-DD

Example: endDate=2023-01-31
clientAccountIdsArray of numbers

Filter by one or multiple ClientAccount IDs (optional). Example usage for multiple IDs: ?clientAccountIds=10&clientAccountIds=20

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/billing-analytics-admin?clientAccountIds=0&endDate=2023-01-31&startDate=2023-01-01' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Array of { clientAccountId, sites[], activeSiteCount }

Bodyapplication/jsonArray [
clientAccountIdnumberrequired

Client Account ID

Example: 10
sitesArray of stringsrequired

List of sites

Example: [{"id":1,"name":"Site One"}]
activeSiteCountnumberrequired

Active site count

Example: 5
]
Response
application/json
[
  {
    "clientAccountId": 10,
    "sites": [ … ],
    "activeSiteCount": 5
  }
]

Retrieve active site analytics for ClientAccount users (or Admin)

Request

If the user is a ClientAccount user, returns only the clientAccountIds they have access to. An Admin can also use this endpoint, seeing all data if no clientAccountIds is provided.

Security
bearer
Query
startDatestring(date-time)

Filter sites by start date (inclusive). Format: YYYY-MM-DD

Example: startDate=2023-01-01
endDatestring(date-time)

Filter sites by end date (inclusive). Format: YYYY-MM-DD

Example: endDate=2023-01-31
clientAccountIdsArray of numbers

Filter by one or multiple ClientAccount IDs (optional). Example usage for multiple IDs: ?clientAccountIds=10&clientAccountIds=20

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/billing-analytics-client-account?clientAccountIds=0&endDate=2023-01-31&startDate=2023-01-01' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Array of { clientAccountId, sites[], activeSiteCount }

Bodyapplication/jsonArray [
clientAccountIdnumberrequired

Client Account ID

Example: 10
sitesArray of stringsrequired

List of sites

Example: [{"id":1,"name":"Site One"}]
activeSiteCountnumberrequired

Active site count

Example: 5
]
Response
application/json
[
  {
    "clientAccountId": 10,
    "sites": [ … ],
    "activeSiteCount": 5
  }
]

Retrieve a site by its ID

Request

Security
bearer
Path
siteIdnumberrequired
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Site retrieved successfully.

Bodyapplication/json
namestringrequired

The name of the site

Example: "Downtown Clinic"
addressobjectrequired

The address of the site

Example: {"street":"123 Main St","city":"New York","zipCode":"10001"}
googlePlaceIdstringrequired

The Google Place ID of the site

Example: "ChIJN1t_tDeuEmsRUsoyG83frY4"
clientAccountIdnumber

The ID of the client Account the site belongs to

Example: 1
organizationIdnumber

The ID of the organization the site belongs to

Example: 1
brandIdnumber

The ID of the brand the site belongs to

Example: 2
phoneNumberstring

The phone number of the site

Example: "+1-555-555-5555"
websitestring

The website of the site

Example: "https://www.downtownclinic.com"
anyDeskIpstring

The AnyDesk IP of the site for remote access

Example: "192.168.1.1"
practiceManagementSystemIdnumberrequired

The practice management system ID for the site

Example: 123
isEnabledboolean

Indicates if the site is enabled

Example: true
siteManagerUserIdnumber

The ID of the decision-maker user

Example: 45
dentalServiceIdsArray of stringsrequired

Array of dental service IDs associated with the site

Example: [1,2,3]
dentalPracticeIdsArray of stringsrequired

Array of dental practice IDs associated with the site

Example: [10,11,12]
cloudUserNamestring

The cloud based username for the site

Example: "cloud-user"
cloudUserPasswordstring

The cloud based user password for the site

Example: "cloud-user-password"
cloudOrganizationNamestring

The cloud based user password for the site

Example: "cloud-organization-name"
cloudLoginUrlstring

The cloud based login url for the site

Example: "https://cloud-login-url.com"
createdAtstringrequired

The date and time the site was created

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

The date and time the site was last updated

Example: "2021-08-01T00:00:00.000Z"
Response
application/json
{
  "name": "Downtown Clinic",
  "address": {
    "street": "123 Main St",
    "city": "New York",
    "zipCode": "10001"
  },
  "googlePlaceId": "ChIJN1t_tDeuEmsRUsoyG83frY4",
  "clientAccountId": 1,
  "organizationId": 1,
  "brandId": 2,
  "phoneNumber": "+1-555-555-5555",
  "website": "https://www.downtownclinic.com",
  "anyDeskIp": "192.168.1.1",
  "practiceManagementSystemId": 123,
  "isEnabled": true,
  "siteManagerUserId": 45,
  "dentalServiceIds": [
    1,
    2,
    3
  ],
  "dentalPracticeIds": [
    10,
    11,
    12
  ],
  "cloudUserName": "cloud-user",
  "cloudUserPassword": "cloud-user-password",
  "cloudOrganizationName": "cloud-organization-name",
  "cloudLoginUrl": "https://cloud-login-url.com",
  "createdAt": "2021-08-01T00:00:00.000Z",
  "updatedAt": "2021-08-01T00:00:00.000Z"
}

Update an existing site

Request

Security
bearer
Path
siteIdnumberrequired
Bodyapplication/jsonrequired
namestringrequired

The name of the site

Example: "Downtown Clinic"
addressobjectrequired

The address of the site

Example: {"street":"123 Main St","city":"New York","zipCode":"10001"}
googlePlaceIdstringrequired

The Google Place ID of the site

Example: "ChIJN1t_tDeuEmsRUsoyG83frY4"
clientAccountIdnumber

The ID of the client Account the site belongs to

Example: 1
organizationIdnumber

The ID of the organization the site belongs to

Example: 1
brandIdnumber

The ID of the brand the site belongs to

Example: 2
phoneNumberstring

The phone number of the site

Example: "+1-555-555-5555"
websitestring

The website of the site

Example: "https://www.downtownclinic.com"
anyDeskIpstring

The AnyDesk IP of the site for remote access

Example: "192.168.1.1"
practiceManagementSystemIdnumberrequired

The practice management system ID for the site

Example: 123
isEnabledboolean

Indicates if the site is enabled

Example: true
siteManagerUserIdnumber

The ID of the decision-maker user

Example: 45
dentalServiceIdsArray of stringsrequired

Array of dental service IDs associated with the site

Example: [1,2,3]
dentalPracticeIdsArray of stringsrequired

Array of dental practice IDs associated with the site

Example: [10,11,12]
cloudUserNamestring

The cloud based username for the site

Example: "cloud-user"
cloudUserPasswordstring

The cloud based user password for the site

Example: "cloud-user-password"
cloudOrganizationNamestring

The cloud based user password for the site

Example: "cloud-organization-name"
cloudLoginUrlstring

The cloud based login url for the site

Example: "https://cloud-login-url.com"
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Downtown Clinic",
    "address": {
      "street": "123 Main St",
      "city": "New York",
      "zipCode": "10001"
    },
    "googlePlaceId": "ChIJN1t_tDeuEmsRUsoyG83frY4",
    "clientAccountId": 1,
    "organizationId": 1,
    "brandId": 2,
    "phoneNumber": "+1-555-555-5555",
    "website": "https://www.downtownclinic.com",
    "anyDeskIp": "192.168.1.1",
    "practiceManagementSystemId": 123,
    "isEnabled": true,
    "siteManagerUserId": 45,
    "dentalServiceIds": [
      1,
      2,
      3
    ],
    "dentalPracticeIds": [
      10,
      11,
      12
    ],
    "cloudUserName": "cloud-user",
    "cloudUserPassword": "cloud-user-password",
    "cloudOrganizationName": "cloud-organization-name",
    "cloudLoginUrl": "https://cloud-login-url.com"
  }'

Responses

Site updated successfully.

Bodyapplication/json
namestringrequired

The name of the site

Example: "Downtown Clinic"
addressobjectrequired

The address of the site

Example: {"street":"123 Main St","city":"New York","zipCode":"10001"}
googlePlaceIdstringrequired

The Google Place ID of the site

Example: "ChIJN1t_tDeuEmsRUsoyG83frY4"
clientAccountIdnumber

The ID of the client Account the site belongs to

Example: 1
organizationIdnumber

The ID of the organization the site belongs to

Example: 1
brandIdnumber

The ID of the brand the site belongs to

Example: 2
phoneNumberstring

The phone number of the site

Example: "+1-555-555-5555"
websitestring

The website of the site

Example: "https://www.downtownclinic.com"
anyDeskIpstring

The AnyDesk IP of the site for remote access

Example: "192.168.1.1"
practiceManagementSystemIdnumberrequired

The practice management system ID for the site

Example: 123
isEnabledboolean

Indicates if the site is enabled

Example: true
siteManagerUserIdnumber

The ID of the decision-maker user

Example: 45
dentalServiceIdsArray of stringsrequired

Array of dental service IDs associated with the site

Example: [1,2,3]
dentalPracticeIdsArray of stringsrequired

Array of dental practice IDs associated with the site

Example: [10,11,12]
cloudUserNamestring

The cloud based username for the site

Example: "cloud-user"
cloudUserPasswordstring

The cloud based user password for the site

Example: "cloud-user-password"
cloudOrganizationNamestring

The cloud based user password for the site

Example: "cloud-organization-name"
cloudLoginUrlstring

The cloud based login url for the site

Example: "https://cloud-login-url.com"
createdAtstringrequired

The date and time the site was created

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

The date and time the site was last updated

Example: "2021-08-01T00:00:00.000Z"
Response
application/json
{
  "name": "Downtown Clinic",
  "address": {
    "street": "123 Main St",
    "city": "New York",
    "zipCode": "10001"
  },
  "googlePlaceId": "ChIJN1t_tDeuEmsRUsoyG83frY4",
  "clientAccountId": 1,
  "organizationId": 1,
  "brandId": 2,
  "phoneNumber": "+1-555-555-5555",
  "website": "https://www.downtownclinic.com",
  "anyDeskIp": "192.168.1.1",
  "practiceManagementSystemId": 123,
  "isEnabled": true,
  "siteManagerUserId": 45,
  "dentalServiceIds": [
    1,
    2,
    3
  ],
  "dentalPracticeIds": [
    10,
    11,
    12
  ],
  "cloudUserName": "cloud-user",
  "cloudUserPassword": "cloud-user-password",
  "cloudOrganizationName": "cloud-organization-name",
  "cloudLoginUrl": "https://cloud-login-url.com",
  "createdAt": "2021-08-01T00:00:00.000Z",
  "updatedAt": "2021-08-01T00:00:00.000Z"
}

Delete a site by its ID

Request

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

Responses

Site deleted successfully.

Response
No content

Reset the FHIR store for a site

Request

Security
bearer
Path
siteIdnumberrequired
Bodyapplication/jsonrequired
forcebooleanrequired

Force reset flag (if true, perform forced reset)

Example: true
curl -i -X POST \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/fhir-reset' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "force": true
  }'

Responses

FHIR reset command queued for processing

Response
No content

Codes

Operations

Site Assistants

Operations

Periomeasure

Operations

Availability

Operations

Users

Operations

Billing Information

Operations