API documentation for HeyDonto API
https://docs.heydonto.com/_mock/apis/heydonto/openapi/
https://api-staging.heydonto.com/
https://api.heydonto.com/
- Mock server
https://docs.heydonto.com/_mock/apis/heydonto/openapi/site
- Sandbox
https://api-staging.heydonto.com/site
- Production
https://api.heydonto.com/site
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site?name=Downtown+Clinic&clientAccountId=1&organizationId=1&brandId=1&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>'
List of sites retrieved successfully.
Array of brands
The URL associated with the address
The Google Place ID for the site
The date and time the site was created
The date and time the site was last updated
The date and time the site was deleted, if applicable
The ID of the client account the site is associated with
The ID of the practice management system used by the site
Integration type for the site
The ID of the FHIR store associated with the site
The date of the first sync with the site
The date of the most recent sync with the site
Indicates whether synchronization is active
The cloud user password for the site
The name of the cloud organization for the site
The URL for cloud login
The title of the client account
The phone number of the client account
The website of the client account
Indicates whether the client account is enabled
The date and time the client account was created
The ID of the organization the site belongs to
The website of the organization
Indicates whether the organization is enabled
The ID of the client account the organization is associated with
The date and time the organization was created
The ID of the organization the brand is associated with
The ID of the client account the brand is associated with
The date and time the brand was created
The ID of the practice management system
The title of the practice management system
Indicates whether the system is cloud-based
Indicates whether the system is enabled
The date and time the system was created
The email of the user
Indicates whether the user is enabled
The date and time the user was created
The date and time the user was last updated
The users associated with the site
The date and time the relationship was created
The email of the site manager
The first name of the site manager
The last name of the site manager
The role of the site manager
Indicates whether the site manager is enabled
The date and time the site manager was created
The date and time the site manager was last updated
{ "data": [ { … } ], "meta": { "page": 0, "pageSize": 10, "total": 150, "totalPages": 15, "hasNext": true, "hasPrevious": false } }
The address of the site
Array of dental service IDs associated with the site
Array of dental practice IDs associated with the site
The cloud based organization name for the site
- Mock server
https://docs.heydonto.com/_mock/apis/heydonto/openapi/site
- Sandbox
https://api-staging.heydonto.com/site
- Production
https://api.heydonto.com/site
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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,
"integrationType": "PMS",
"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"
}'
Site created successfully.
The URL associated with the address
The ID of the practice management system used by the site
Integration type for the site
The ID of the FHIR store associated with the site
The date of the most recent sync with the site
The name of the cloud organization for the site
The phone number of the client account
The website of the client account
Indicates whether the client account is enabled
The date and time the client account was created
The website of the organization
The ID of the client account the organization is associated with
The date and time the organization was created
The ID of the organization the brand is associated with
The ID of the client account the brand is associated with
The date and time the brand was created
The title of the practice management system
Indicates whether the system is cloud-based
Indicates whether the system is enabled
The date and time the system was created
The date and time the user was created
The date and time the user was last updated
The users associated with the site
The date and time the relationship was created
The email of the site manager
Indicates whether the site manager is enabled
The date and time the site manager was created
The date and time the site manager was last updated
{ "id": 123, "name": "Downtown Clinic", "address": { "lat": 37.7749, "lng": -122.4194, "url": "https://maps.google.com/?q=123+Main+St", "formatted_address": "123 Main St, San Francisco, CA 94103" }, "googlePlaceId": "ChIJN1t_tDeuEmsRUsoyG83frY4", "phoneNumber": "+1 (555) 123-4567", "website": "https://downtownclinic.com", "anyDeskIp": "192.168.1.100", "createdByUserId": 202, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z", "deletedAt": "null", "clientAccountId": 456, "organizationId": 789, "brandId": 101, "practiceManagementSystemId": 202, "integrationType": "PMS", "licenseKey": "XXX-YYY-ZZZ-AAA-BBB", "fhirStoreId": "fhir-store-123", "firstSyncDate": "2021-05-15T12:00:00Z", "latestSyncDate": "2021-06-01T12:00:00Z", "synchronizationIsActive": true, "siteManagerUserId": 303, "cloudUserName": "downtown.clinic", "cloudUserPassword": "encrypted-password", "cloudOrganizationName": "HealthCorp Cloud", "cloudLoginUrl": "https://cloud.healthcorp.com/login", "clientAccount": { "id": 456, "title": "HealthCorp Client", "phoneNumber": "+1 (555) 123-4567", "website": "https://healthcorp.com", "isEnabled": true, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z" }, "organization": { "id": 123, "title": "HealthCorp", "website": "https://healthcorp.com", "isEnabled": true, "clientAccountId": 456, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z" }, "brand": { "id": 789, "title": "HealthCorp Brand", "isEnabled": true, "organizationId": 123, "clientAccountId": 456, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z" }, "practiceManagementSystem": { "id": 101, "title": "MedicalSoft Pro", "isCloudBased": true, "isEnabled": true, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z" }, "createdByUser": { "id": 202, "email": "john.doe@healthcorp.com", "firstName": "John", "lastName": "Doe", "role": "ADMIN", "isEnabled": true, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z", "lastLoginDate": "2021-06-01T12:00:00Z" }, "siteUsers": [ { … } ], "siteManagerUser": { "id": 303, "email": "manager@healthcorp.com", "firstName": "Jane", "lastName": "Smith", "role": "SITE_MANAGER_USER", "isEnabled": true, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z", "lastLoginDate": "2021-06-01T12:00:00Z" }, "integrationTosAcceptedAt": "2021-08-01T00:00:00.000Z" }
- Mock server
https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}
- Sandbox
https://api-staging.heydonto.com/site/{siteId}
- Production
https://api.heydonto.com/site/{siteId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
Site retrieved successfully.
The URL associated with the address
The ID of the practice management system used by the site
Integration type for the site
The ID of the FHIR store associated with the site
The date of the most recent sync with the site
The name of the cloud organization for the site
The phone number of the client account
The website of the client account
Indicates whether the client account is enabled
The date and time the client account was created
The website of the organization
The ID of the client account the organization is associated with
The date and time the organization was created
The ID of the organization the brand is associated with
The ID of the client account the brand is associated with
The date and time the brand was created
The title of the practice management system
Indicates whether the system is cloud-based
Indicates whether the system is enabled
The date and time the system was created
The date and time the user was created
The date and time the user was last updated
The users associated with the site
The date and time the relationship was created
The email of the site manager
Indicates whether the site manager is enabled
The date and time the site manager was created
The date and time the site manager was last updated
{ "id": 123, "name": "Downtown Clinic", "address": { "lat": 37.7749, "lng": -122.4194, "url": "https://maps.google.com/?q=123+Main+St", "formatted_address": "123 Main St, San Francisco, CA 94103" }, "googlePlaceId": "ChIJN1t_tDeuEmsRUsoyG83frY4", "phoneNumber": "+1 (555) 123-4567", "website": "https://downtownclinic.com", "anyDeskIp": "192.168.1.100", "createdByUserId": 202, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z", "deletedAt": "null", "clientAccountId": 456, "organizationId": 789, "brandId": 101, "practiceManagementSystemId": 202, "integrationType": "PMS", "licenseKey": "XXX-YYY-ZZZ-AAA-BBB", "fhirStoreId": "fhir-store-123", "firstSyncDate": "2021-05-15T12:00:00Z", "latestSyncDate": "2021-06-01T12:00:00Z", "synchronizationIsActive": true, "siteManagerUserId": 303, "cloudUserName": "downtown.clinic", "cloudUserPassword": "encrypted-password", "cloudOrganizationName": "HealthCorp Cloud", "cloudLoginUrl": "https://cloud.healthcorp.com/login", "clientAccount": { "id": 456, "title": "HealthCorp Client", "phoneNumber": "+1 (555) 123-4567", "website": "https://healthcorp.com", "isEnabled": true, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z" }, "organization": { "id": 123, "title": "HealthCorp", "website": "https://healthcorp.com", "isEnabled": true, "clientAccountId": 456, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z" }, "brand": { "id": 789, "title": "HealthCorp Brand", "isEnabled": true, "organizationId": 123, "clientAccountId": 456, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z" }, "practiceManagementSystem": { "id": 101, "title": "MedicalSoft Pro", "isCloudBased": true, "isEnabled": true, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z" }, "createdByUser": { "id": 202, "email": "john.doe@healthcorp.com", "firstName": "John", "lastName": "Doe", "role": "ADMIN", "isEnabled": true, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z", "lastLoginDate": "2021-06-01T12:00:00Z" }, "siteUsers": [ { … } ], "siteManagerUser": { "id": 303, "email": "manager@healthcorp.com", "firstName": "Jane", "lastName": "Smith", "role": "SITE_MANAGER_USER", "isEnabled": true, "createdAt": "2021-05-01T12:00:00Z", "updatedAt": "2021-05-01T12:00:00Z", "lastLoginDate": "2021-06-01T12:00:00Z" }, "integrationTosAcceptedAt": "2021-08-01T00:00:00.000Z" }
The address of the site
Array of dental service IDs associated with the site
Array of dental practice IDs associated with the site
The cloud based organization name for the site
- Mock server
https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}
- Sandbox
https://api-staging.heydonto.com/site/{siteId}
- Production
https://api.heydonto.com/site/{siteId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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,
"integrationType": "PMS",
"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"
}'
Site updated successfully.
The address of the site
Array of dental service IDs associated with the site
Array of dental practice IDs associated with the site
The cloud based organization name for the site
{ "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, "integrationType": "PMS", "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" }
- Mock server
https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}
- Sandbox
https://api-staging.heydonto.com/site/{siteId}
- Production
https://api.heydonto.com/site/{siteId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
- Mock server
https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/billing-analytics-admin
- Sandbox
https://api-staging.heydonto.com/site/billing-analytics-admin
- Production
https://api.heydonto.com/site/billing-analytics-admin
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/billing-analytics-admin?startDate=2023-01-01&endDate=2023-01-31&clientAccountIds=0' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
[ { "clientAccountId": 10, "sites": [ … ], "activeSiteCount": 5 } ]
- Mock server
https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/billing-analytics-client-account
- Sandbox
https://api-staging.heydonto.com/site/billing-analytics-client-account
- Production
https://api.heydonto.com/site/billing-analytics-client-account
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/billing-analytics-client-account?startDate=2023-01-01&endDate=2023-01-31&clientAccountIds=0' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
[ { "clientAccountId": 10, "sites": [ … ], "activeSiteCount": 5 } ]
- Mock server
https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/fhir-reset
- Sandbox
https://api-staging.heydonto.com/site/{siteId}/fhir-reset
- Production
https://api.heydonto.com/site/{siteId}/fhir-reset
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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
}'
- Mock server
https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/integration-tos/accept
- Sandbox
https://api-staging.heydonto.com/site/integration-tos/accept
- Production
https://api.heydonto.com/site/integration-tos/accept
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/integration-tos/accept \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
- Mock server
https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/integration-tos/resend
- Sandbox
https://api-staging.heydonto.com/site/{siteId}/integration-tos/resend
- Production
https://api.heydonto.com/site/{siteId}/integration-tos/resend
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/integration-tos/resend' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
- Mock server
https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/fhir-mapping-state
- Sandbox
https://api-staging.heydonto.com/site/{siteId}/fhir-mapping-state
- Production
https://api.heydonto.com/site/{siteId}/fhir-mapping-state
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/fhir-mapping-state?resourceType=string&fhirId=string&ehrResourceId=string&fhirStoreStatus=UNMAPPED&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>'
{ "data": [ { … } ], "meta": { "page": 0, "pageSize": 10, "total": 150, "totalPages": 15, "hasNext": true, "hasPrevious": false } }
- Mock server
https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/fhir-mapping-state/resource-types
- Sandbox
https://api-staging.heydonto.com/site/{siteId}/fhir-mapping-state/resource-types
- Production
https://api.heydonto.com/site/{siteId}/fhir-mapping-state/resource-types
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/{siteId}/fhir-mapping-state/resource-types' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'
[ "string" ]