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

Organizations

Operations

Practice Management Systems

Operations

Stroage

Operations

Site Assistants

Operations

Sites

Operations

Retrieve all sites with optional filters

Request

Security
bearer
Query
namestring

The name of the site

Example: name=Downtown Clinic
clientAccountIdArray of numbers

The clientAccountId of the site

Example: clientAccountId=1
organizationIdArray of numbers

The organizationId of the site

Example: organizationId=1
brandIdArray of numbers

The brandId of the site

Example: brandId=1
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""name""createdAt""updatedAt""clientAccountId""organizationId""brandId""practiceManagementSystemId"
sortBy[0][dir]string

First sort direction

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

Second sort field

Enum"id""name""createdAt""updatedAt""clientAccountId""organizationId""brandId""practiceManagementSystemId"
sortBy[1][dir]string

Second sort direction

Enum"asc""desc"
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>'

Responses

List of sites retrieved successfully.

Bodyapplication/json
dataArray of objects(SiteDto)required

Array of brands

data[].​idnumberrequired

The ID of the site

Example: 123
data[].​namestringrequired

The name of the site

Example: "Downtown Clinic"
data[].​addressobjectrequired
data[].​address.​latnumberrequired

The latitude coordinate of the address

Example: 37.7749
data[].​address.​lngnumberrequired

The longitude coordinate of the address

Example: -122.4194
data[].​address.​urlstringrequired

The URL associated with the address

Example: "https://maps.google.com/?q=123+Main+St"
data[].​address.​formatted_addressstringrequired

The formatted address string

Example: "123 Main St, San Francisco, CA 94103"
data[].​googlePlaceIdstringrequired

The Google Place ID for the site

Example: "ChIJN1t_tDeuEmsRUsoyG83frY4"
data[].​phoneNumberstring or null

The phone number of the site

Example: "+1 (555) 123-4567"
data[].​websitestring or null

The website of the site

Example: "https://downtownclinic.com"
data[].​anyDeskIpstring or null

The AnyDesk IP address for remote access

Example: "192.168.1.100"
data[].​createdByUserIdnumberrequired

The ID of the user who created the site

Example: 202
data[].​createdAtstringrequired

The date and time the site was created

Example: "2021-05-01T12:00:00Z"
data[].​updatedAtstringrequired

The date and time the site was last updated

Example: "2021-05-01T12:00:00Z"
data[].​deletedAtstring or null

The date and time the site was deleted, if applicable

Example: "null"
data[].​clientAccountIdnumberrequired

The ID of the client account the site is associated with

Example: 456
data[].​organizationIdnumberrequired

The ID of the organization the site belongs to

Example: 789
data[].​brandIdnumberrequired

The ID of the brand the site is associated with

Example: 101
data[].​practiceManagementSystemIdnumber or null

The ID of the practice management system used by the site

Example: 202
data[].​integrationTypestringrequired

Integration type for the site

Default "PMS"
Enum"PMS""CUSTOM"
Example: "PMS"
data[].​licenseKeystring or null

The license key for the site

Example: "XXX-YYY-ZZZ-AAA-BBB"
data[].​fhirStoreIdstring or null

The ID of the FHIR store associated with the site

Example: "fhir-store-123"
data[].​firstSyncDatestring or null

The date of the first sync with the site

Example: "2021-05-15T12:00:00Z"
data[].​latestSyncDatestring or null

The date of the most recent sync with the site

Example: "2021-06-01T12:00:00Z"
data[].​synchronizationIsActiveboolean or null

Indicates whether synchronization is active

Example: true
data[].​siteManagerUserIdnumberrequired

The ID of the user who manages the site

Example: 303
data[].​cloudUserNamestring or null

The cloud username for the site

Example: "downtown.clinic"
data[].​cloudUserPasswordstring or null

The cloud user password for the site

Example: "encrypted-password"
data[].​cloudOrganizationNamestring or null

The name of the cloud organization for the site

Example: "HealthCorp Cloud"
data[].​cloudLoginUrlstring or null

The URL for cloud login

Example: "https://cloud.healthcorp.com/login"
data[].​clientAccountobjectrequired
data[].​clientAccount.​idnumberrequired

The ID of the client account

Example: 456
data[].​clientAccount.​titlestringrequired

The title of the client account

Example: "HealthCorp Client"
data[].​clientAccount.​phoneNumberstring or null

The phone number of the client account

Example: "+1 (555) 123-4567"
data[].​clientAccount.​websitestring or null

The website of the client account

Example: "https://healthcorp.com"
data[].​clientAccount.​isEnabledbooleanrequired

Indicates whether the client account is enabled

Example: true
data[].​clientAccount.​createdAtstringrequired

The date and time the client account was created

Example: "2021-05-01T12:00:00Z"
data[].​clientAccount.​updatedAtstringrequired

The date and time the client account was last updated

Example: "2021-05-01T12:00:00Z"
data[].​organizationobjectrequired
data[].​organization.​idnumberrequired

The ID of the organization the site belongs to

Example: 123
data[].​organization.​titlestringrequired

The title of the organization

Example: "HealthCorp"
data[].​organization.​websitestring or null

The website of the organization

Example: "https://healthcorp.com"
data[].​organization.​isEnabledbooleanrequired

Indicates whether the organization is enabled

Example: true
data[].​organization.​clientAccountIdnumber or null

The ID of the client account the organization is associated with

Example: 456
data[].​organization.​createdAtstringrequired

The date and time the organization was created

Example: "2021-05-01T12:00:00Z"
data[].​organization.​updatedAtstringrequired

The date and time the organization was last updated

Example: "2021-05-01T12:00:00Z"
data[].​brandobjectrequired
data[].​brand.​idnumberrequired

The ID of the brand the site is associated with

Example: 789
data[].​brand.​titlestringrequired

The title of the brand

Example: "HealthCorp Brand"
data[].​brand.​isEnabledbooleanrequired

Indicates whether the brand is enabled

Example: true
data[].​brand.​organizationIdnumber or null

The ID of the organization the brand is associated with

Example: 123
data[].​brand.​clientAccountIdnumber or null

The ID of the client account the brand is associated with

Example: 456
data[].​brand.​createdAtstringrequired

The date and time the brand was created

Example: "2021-05-01T12:00:00Z"
data[].​brand.​updatedAtstringrequired

The date and time the brand was last updated

Example: "2021-05-01T12:00:00Z"
data[].​practiceManagementSystemobjectrequired
data[].​practiceManagementSystem.​idnumberrequired

The ID of the practice management system

Example: 101
data[].​practiceManagementSystem.​titlestringrequired

The title of the practice management system

Example: "MedicalSoft Pro"
data[].​practiceManagementSystem.​isCloudBasedbooleanrequired

Indicates whether the system is cloud-based

Example: true
data[].​practiceManagementSystem.​isEnabledbooleanrequired

Indicates whether the system is enabled

Example: true
data[].​practiceManagementSystem.​createdAtstringrequired

The date and time the system was created

Example: "2021-05-01T12:00:00Z"
data[].​practiceManagementSystem.​updatedAtstringrequired

The date and time the system was last updated

Example: "2021-05-01T12:00:00Z"
data[].​createdByUserobjectrequired
data[].​createdByUser.​idnumberrequired

The ID of the user who created the site

Example: 202
data[].​createdByUser.​emailstringrequired

The email of the user

Example: "john.doe@healthcorp.com"
data[].​createdByUser.​firstNamestringrequired

The first name of the user

Example: "John"
data[].​createdByUser.​lastNamestringrequired

The last name of the user

Example: "Doe"
data[].​createdByUser.​rolestringrequired

The role of the user

Example: "ADMIN"
data[].​createdByUser.​isEnabledbooleanrequired

Indicates whether the user is enabled

Example: true
data[].​createdByUser.​createdAtstringrequired

The date and time the user was created

Example: "2021-05-01T12:00:00Z"
data[].​createdByUser.​updatedAtstringrequired

The date and time the user was last updated

Example: "2021-05-01T12:00:00Z"
data[].​createdByUser.​lastLoginDatestring or null

The date and time the user last logged in

Example: "2021-06-01T12:00:00Z"
data[].​siteUsersArray of objects(SiteUserDto)required

The users associated with the site

data[].​siteUsers[].​idnumberrequired

The ID of the user-site relationship

Example: 404
data[].​siteUsers[].​userIdnumberrequired

The ID of the user

Example: 505
data[].​siteUsers[].​siteIdnumberrequired

The ID of the site

Example: 606
data[].​siteUsers[].​createdAtstringrequired

The date and time the relationship was created

Example: "2021-05-01T12:00:00Z"
data[].​siteUsers[].​updatedAtstringrequired

The date and time the relationship was last updated

Example: "2021-05-01T12:00:00Z"
data[].​siteManagerUserobjectrequired
data[].​siteManagerUser.​idnumberrequired

The ID of the user who manages the site

Example: 303
data[].​siteManagerUser.​emailstringrequired

The email of the site manager

Example: "manager@healthcorp.com"
data[].​siteManagerUser.​firstNamestringrequired

The first name of the site manager

Example: "Jane"
data[].​siteManagerUser.​lastNamestringrequired

The last name of the site manager

Example: "Smith"
data[].​siteManagerUser.​rolestringrequired

The role of the site manager

Example: "SITE_MANAGER_USER"
data[].​siteManagerUser.​isEnabledbooleanrequired

Indicates whether the site manager is enabled

Example: true
data[].​siteManagerUser.​createdAtstringrequired

The date and time the site manager was created

Example: "2021-05-01T12:00:00Z"
data[].​siteManagerUser.​updatedAtstringrequired

The date and time the site manager was last updated

Example: "2021-05-01T12:00:00Z"
data[].​siteManagerUser.​lastLoginDatestring or null

The date and time the site manager last logged in

Example: "2021-06-01T12:00:00Z"
data[].​integrationTosAcceptedAtstring(date-time)required

The date and time the site accepted the integration TOS

Example: "2021-08-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 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"
clientAccountIdnumberrequired

The ID of the client Account the site belongs to

Example: 1
organizationIdnumberrequired

The ID of the organization the site belongs to

Example: 1
brandIdnumberrequired

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
integrationTypestringrequired

Integration type for the site

Enum"PMS""CUSTOM"
Example: "PMS"
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 organization name 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,
    "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"
  }'

Responses

Site created successfully.

Bodyapplication/json
idnumberrequired

The ID of the site

Example: 123
namestringrequired

The name of the site

Example: "Downtown Clinic"
addressobjectrequired
address.​latnumberrequired

The latitude coordinate of the address

Example: 37.7749
address.​lngnumberrequired

The longitude coordinate of the address

Example: -122.4194
address.​urlstringrequired

The URL associated with the address

Example: "https://maps.google.com/?q=123+Main+St"
address.​formatted_addressstringrequired

The formatted address string

Example: "123 Main St, San Francisco, CA 94103"
googlePlaceIdstringrequired

The Google Place ID for the site

Example: "ChIJN1t_tDeuEmsRUsoyG83frY4"
phoneNumberstring or null

The phone number of the site

Example: "+1 (555) 123-4567"
websitestring or null

The website of the site

Example: "https://downtownclinic.com"
anyDeskIpstring or null

The AnyDesk IP address for remote access

Example: "192.168.1.100"
createdByUserIdnumberrequired

The ID of the user who created the site

Example: 202
createdAtstringrequired

The date and time the site was created

Example: "2021-05-01T12:00:00Z"
updatedAtstringrequired

The date and time the site was last updated

Example: "2021-05-01T12:00:00Z"
deletedAtstring or null

The date and time the site was deleted, if applicable

Example: "null"
clientAccountIdnumberrequired

The ID of the client account the site is associated with

Example: 456
organizationIdnumberrequired

The ID of the organization the site belongs to

Example: 789
brandIdnumberrequired

The ID of the brand the site is associated with

Example: 101
practiceManagementSystemIdnumber or null

The ID of the practice management system used by the site

Example: 202
integrationTypestringrequired

Integration type for the site

Default "PMS"
Enum"PMS""CUSTOM"
Example: "PMS"
licenseKeystring or null

The license key for the site

Example: "XXX-YYY-ZZZ-AAA-BBB"
fhirStoreIdstring or null

The ID of the FHIR store associated with the site

Example: "fhir-store-123"
firstSyncDatestring or null

The date of the first sync with the site

Example: "2021-05-15T12:00:00Z"
latestSyncDatestring or null

The date of the most recent sync with the site

Example: "2021-06-01T12:00:00Z"
synchronizationIsActiveboolean or null

Indicates whether synchronization is active

Example: true
siteManagerUserIdnumberrequired

The ID of the user who manages the site

Example: 303
cloudUserNamestring or null

The cloud username for the site

Example: "downtown.clinic"
cloudUserPasswordstring or null

The cloud user password for the site

Example: "encrypted-password"
cloudOrganizationNamestring or null

The name of the cloud organization for the site

Example: "HealthCorp Cloud"
cloudLoginUrlstring or null

The URL for cloud login

Example: "https://cloud.healthcorp.com/login"
clientAccountobjectrequired
clientAccount.​idnumberrequired

The ID of the client account

Example: 456
clientAccount.​titlestringrequired

The title of the client account

Example: "HealthCorp Client"
clientAccount.​phoneNumberstring or null

The phone number of the client account

Example: "+1 (555) 123-4567"
clientAccount.​websitestring or null

The website of the client account

Example: "https://healthcorp.com"
clientAccount.​isEnabledbooleanrequired

Indicates whether the client account is enabled

Example: true
clientAccount.​createdAtstringrequired

The date and time the client account was created

Example: "2021-05-01T12:00:00Z"
clientAccount.​updatedAtstringrequired

The date and time the client account was last updated

Example: "2021-05-01T12:00:00Z"
organizationobjectrequired
organization.​idnumberrequired

The ID of the organization the site belongs to

Example: 123
organization.​titlestringrequired

The title of the organization

Example: "HealthCorp"
organization.​websitestring or null

The website of the organization

Example: "https://healthcorp.com"
organization.​isEnabledbooleanrequired

Indicates whether the organization is enabled

Example: true
organization.​clientAccountIdnumber or null

The ID of the client account the organization is associated with

Example: 456
organization.​createdAtstringrequired

The date and time the organization was created

Example: "2021-05-01T12:00:00Z"
organization.​updatedAtstringrequired

The date and time the organization was last updated

Example: "2021-05-01T12:00:00Z"
brandobjectrequired
brand.​idnumberrequired

The ID of the brand the site is associated with

Example: 789
brand.​titlestringrequired

The title of the brand

Example: "HealthCorp Brand"
brand.​isEnabledbooleanrequired

Indicates whether the brand is enabled

Example: true
brand.​organizationIdnumber or null

The ID of the organization the brand is associated with

Example: 123
brand.​clientAccountIdnumber or null

The ID of the client account the brand is associated with

Example: 456
brand.​createdAtstringrequired

The date and time the brand was created

Example: "2021-05-01T12:00:00Z"
brand.​updatedAtstringrequired

The date and time the brand was last updated

Example: "2021-05-01T12:00:00Z"
practiceManagementSystemobjectrequired
practiceManagementSystem.​idnumberrequired

The ID of the practice management system

Example: 101
practiceManagementSystem.​titlestringrequired

The title of the practice management system

Example: "MedicalSoft Pro"
practiceManagementSystem.​isCloudBasedbooleanrequired

Indicates whether the system is cloud-based

Example: true
practiceManagementSystem.​isEnabledbooleanrequired

Indicates whether the system is enabled

Example: true
practiceManagementSystem.​createdAtstringrequired

The date and time the system was created

Example: "2021-05-01T12:00:00Z"
practiceManagementSystem.​updatedAtstringrequired

The date and time the system was last updated

Example: "2021-05-01T12:00:00Z"
createdByUserobjectrequired
createdByUser.​idnumberrequired

The ID of the user who created the site

Example: 202
createdByUser.​emailstringrequired

The email of the user

Example: "john.doe@healthcorp.com"
createdByUser.​firstNamestringrequired

The first name of the user

Example: "John"
createdByUser.​lastNamestringrequired

The last name of the user

Example: "Doe"
createdByUser.​rolestringrequired

The role of the user

Example: "ADMIN"
createdByUser.​isEnabledbooleanrequired

Indicates whether the user is enabled

Example: true
createdByUser.​createdAtstringrequired

The date and time the user was created

Example: "2021-05-01T12:00:00Z"
createdByUser.​updatedAtstringrequired

The date and time the user was last updated

Example: "2021-05-01T12:00:00Z"
createdByUser.​lastLoginDatestring or null

The date and time the user last logged in

Example: "2021-06-01T12:00:00Z"
siteUsersArray of objects(SiteUserDto)required

The users associated with the site

siteUsers[].​idnumberrequired

The ID of the user-site relationship

Example: 404
siteUsers[].​userIdnumberrequired

The ID of the user

Example: 505
siteUsers[].​siteIdnumberrequired

The ID of the site

Example: 606
siteUsers[].​createdAtstringrequired

The date and time the relationship was created

Example: "2021-05-01T12:00:00Z"
siteUsers[].​updatedAtstringrequired

The date and time the relationship was last updated

Example: "2021-05-01T12:00:00Z"
siteManagerUserobjectrequired
siteManagerUser.​idnumberrequired

The ID of the user who manages the site

Example: 303
siteManagerUser.​emailstringrequired

The email of the site manager

Example: "manager@healthcorp.com"
siteManagerUser.​firstNamestringrequired

The first name of the site manager

Example: "Jane"
siteManagerUser.​lastNamestringrequired

The last name of the site manager

Example: "Smith"
siteManagerUser.​rolestringrequired

The role of the site manager

Example: "SITE_MANAGER_USER"
siteManagerUser.​isEnabledbooleanrequired

Indicates whether the site manager is enabled

Example: true
siteManagerUser.​createdAtstringrequired

The date and time the site manager was created

Example: "2021-05-01T12:00:00Z"
siteManagerUser.​updatedAtstringrequired

The date and time the site manager was last updated

Example: "2021-05-01T12:00:00Z"
siteManagerUser.​lastLoginDatestring or null

The date and time the site manager last logged in

Example: "2021-06-01T12:00:00Z"
integrationTosAcceptedAtstring(date-time)required

The date and time the site accepted the integration TOS

Example: "2021-08-01T00:00:00.000Z"
Response
application/json
{
  "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"
}

Retrieve a site by 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
idnumberrequired

The ID of the site

Example: 123
namestringrequired

The name of the site

Example: "Downtown Clinic"
addressobjectrequired
address.​latnumberrequired

The latitude coordinate of the address

Example: 37.7749
address.​lngnumberrequired

The longitude coordinate of the address

Example: -122.4194
address.​urlstringrequired

The URL associated with the address

Example: "https://maps.google.com/?q=123+Main+St"
address.​formatted_addressstringrequired

The formatted address string

Example: "123 Main St, San Francisco, CA 94103"
googlePlaceIdstringrequired

The Google Place ID for the site

Example: "ChIJN1t_tDeuEmsRUsoyG83frY4"
phoneNumberstring or null

The phone number of the site

Example: "+1 (555) 123-4567"
websitestring or null

The website of the site

Example: "https://downtownclinic.com"
anyDeskIpstring or null

The AnyDesk IP address for remote access

Example: "192.168.1.100"
createdByUserIdnumberrequired

The ID of the user who created the site

Example: 202
createdAtstringrequired

The date and time the site was created

Example: "2021-05-01T12:00:00Z"
updatedAtstringrequired

The date and time the site was last updated

Example: "2021-05-01T12:00:00Z"
deletedAtstring or null

The date and time the site was deleted, if applicable

Example: "null"
clientAccountIdnumberrequired

The ID of the client account the site is associated with

Example: 456
organizationIdnumberrequired

The ID of the organization the site belongs to

Example: 789
brandIdnumberrequired

The ID of the brand the site is associated with

Example: 101
practiceManagementSystemIdnumber or null

The ID of the practice management system used by the site

Example: 202
integrationTypestringrequired

Integration type for the site

Default "PMS"
Enum"PMS""CUSTOM"
Example: "PMS"
licenseKeystring or null

The license key for the site

Example: "XXX-YYY-ZZZ-AAA-BBB"
fhirStoreIdstring or null

The ID of the FHIR store associated with the site

Example: "fhir-store-123"
firstSyncDatestring or null

The date of the first sync with the site

Example: "2021-05-15T12:00:00Z"
latestSyncDatestring or null

The date of the most recent sync with the site

Example: "2021-06-01T12:00:00Z"
synchronizationIsActiveboolean or null

Indicates whether synchronization is active

Example: true
siteManagerUserIdnumberrequired

The ID of the user who manages the site

Example: 303
cloudUserNamestring or null

The cloud username for the site

Example: "downtown.clinic"
cloudUserPasswordstring or null

The cloud user password for the site

Example: "encrypted-password"
cloudOrganizationNamestring or null

The name of the cloud organization for the site

Example: "HealthCorp Cloud"
cloudLoginUrlstring or null

The URL for cloud login

Example: "https://cloud.healthcorp.com/login"
clientAccountobjectrequired
clientAccount.​idnumberrequired

The ID of the client account

Example: 456
clientAccount.​titlestringrequired

The title of the client account

Example: "HealthCorp Client"
clientAccount.​phoneNumberstring or null

The phone number of the client account

Example: "+1 (555) 123-4567"
clientAccount.​websitestring or null

The website of the client account

Example: "https://healthcorp.com"
clientAccount.​isEnabledbooleanrequired

Indicates whether the client account is enabled

Example: true
clientAccount.​createdAtstringrequired

The date and time the client account was created

Example: "2021-05-01T12:00:00Z"
clientAccount.​updatedAtstringrequired

The date and time the client account was last updated

Example: "2021-05-01T12:00:00Z"
organizationobjectrequired
organization.​idnumberrequired

The ID of the organization the site belongs to

Example: 123
organization.​titlestringrequired

The title of the organization

Example: "HealthCorp"
organization.​websitestring or null

The website of the organization

Example: "https://healthcorp.com"
organization.​isEnabledbooleanrequired

Indicates whether the organization is enabled

Example: true
organization.​clientAccountIdnumber or null

The ID of the client account the organization is associated with

Example: 456
organization.​createdAtstringrequired

The date and time the organization was created

Example: "2021-05-01T12:00:00Z"
organization.​updatedAtstringrequired

The date and time the organization was last updated

Example: "2021-05-01T12:00:00Z"
brandobjectrequired
brand.​idnumberrequired

The ID of the brand the site is associated with

Example: 789
brand.​titlestringrequired

The title of the brand

Example: "HealthCorp Brand"
brand.​isEnabledbooleanrequired

Indicates whether the brand is enabled

Example: true
brand.​organizationIdnumber or null

The ID of the organization the brand is associated with

Example: 123
brand.​clientAccountIdnumber or null

The ID of the client account the brand is associated with

Example: 456
brand.​createdAtstringrequired

The date and time the brand was created

Example: "2021-05-01T12:00:00Z"
brand.​updatedAtstringrequired

The date and time the brand was last updated

Example: "2021-05-01T12:00:00Z"
practiceManagementSystemobjectrequired
practiceManagementSystem.​idnumberrequired

The ID of the practice management system

Example: 101
practiceManagementSystem.​titlestringrequired

The title of the practice management system

Example: "MedicalSoft Pro"
practiceManagementSystem.​isCloudBasedbooleanrequired

Indicates whether the system is cloud-based

Example: true
practiceManagementSystem.​isEnabledbooleanrequired

Indicates whether the system is enabled

Example: true
practiceManagementSystem.​createdAtstringrequired

The date and time the system was created

Example: "2021-05-01T12:00:00Z"
practiceManagementSystem.​updatedAtstringrequired

The date and time the system was last updated

Example: "2021-05-01T12:00:00Z"
createdByUserobjectrequired
createdByUser.​idnumberrequired

The ID of the user who created the site

Example: 202
createdByUser.​emailstringrequired

The email of the user

Example: "john.doe@healthcorp.com"
createdByUser.​firstNamestringrequired

The first name of the user

Example: "John"
createdByUser.​lastNamestringrequired

The last name of the user

Example: "Doe"
createdByUser.​rolestringrequired

The role of the user

Example: "ADMIN"
createdByUser.​isEnabledbooleanrequired

Indicates whether the user is enabled

Example: true
createdByUser.​createdAtstringrequired

The date and time the user was created

Example: "2021-05-01T12:00:00Z"
createdByUser.​updatedAtstringrequired

The date and time the user was last updated

Example: "2021-05-01T12:00:00Z"
createdByUser.​lastLoginDatestring or null

The date and time the user last logged in

Example: "2021-06-01T12:00:00Z"
siteUsersArray of objects(SiteUserDto)required

The users associated with the site

siteUsers[].​idnumberrequired

The ID of the user-site relationship

Example: 404
siteUsers[].​userIdnumberrequired

The ID of the user

Example: 505
siteUsers[].​siteIdnumberrequired

The ID of the site

Example: 606
siteUsers[].​createdAtstringrequired

The date and time the relationship was created

Example: "2021-05-01T12:00:00Z"
siteUsers[].​updatedAtstringrequired

The date and time the relationship was last updated

Example: "2021-05-01T12:00:00Z"
siteManagerUserobjectrequired
siteManagerUser.​idnumberrequired

The ID of the user who manages the site

Example: 303
siteManagerUser.​emailstringrequired

The email of the site manager

Example: "manager@healthcorp.com"
siteManagerUser.​firstNamestringrequired

The first name of the site manager

Example: "Jane"
siteManagerUser.​lastNamestringrequired

The last name of the site manager

Example: "Smith"
siteManagerUser.​rolestringrequired

The role of the site manager

Example: "SITE_MANAGER_USER"
siteManagerUser.​isEnabledbooleanrequired

Indicates whether the site manager is enabled

Example: true
siteManagerUser.​createdAtstringrequired

The date and time the site manager was created

Example: "2021-05-01T12:00:00Z"
siteManagerUser.​updatedAtstringrequired

The date and time the site manager was last updated

Example: "2021-05-01T12:00:00Z"
siteManagerUser.​lastLoginDatestring or null

The date and time the site manager last logged in

Example: "2021-06-01T12:00:00Z"
integrationTosAcceptedAtstring(date-time)required

The date and time the site accepted the integration TOS

Example: "2021-08-01T00:00:00.000Z"
Response
application/json
{
  "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"
}

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"
clientAccountIdnumberrequired

The ID of the client Account the site belongs to

Example: 1
organizationIdnumberrequired

The ID of the organization the site belongs to

Example: 1
brandIdnumberrequired

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
integrationTypestringrequired

Integration type for the site

Enum"PMS""CUSTOM"
Example: "PMS"
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 organization name 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,
    "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"
  }'

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"
clientAccountIdnumberrequired

The ID of the client Account the site belongs to

Example: 1
organizationIdnumberrequired

The ID of the organization the site belongs to

Example: 1
brandIdnumberrequired

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
integrationTypestringrequired

Integration type for the site

Enum"PMS""CUSTOM"
Example: "PMS"
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 organization name for the site

Example: "cloud-organization-name"
cloudLoginUrlstring

The cloud based login url for the site

Example: "https://cloud-login-url.com"
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,
  "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"
}

Delete a site

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

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?startDate=2023-01-01&endDate=2023-01-31&clientAccountIds=0' \
  -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: ["[object Object]"]
activeSiteCountnumberrequired

Active site count

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

Retrieve active site analytics for client account 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?startDate=2023-01-01&endDate=2023-01-31&clientAccountIds=0' \
  -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: ["[object Object]"]
activeSiteCountnumberrequired

Active site count

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

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

Accept the integration TOS for a site

Request

Security
bearer
curl -i -X POST \
  https://docs.heydonto.com/_mock/apis/heydonto/openapi/site/integration-tos/accept \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Integration TOS accepted

Response
No content

Resend the integration TOS for a site

Request

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

Responses

Integration TOS resent

Response
No content

Retrieve the list of site FHIR mapping state records

Request

Security
bearer
Path
siteIdnumberrequired
Query
resourceTypestring

Filter by FHIR resource type

fhirIdstring

Filter by FHIR ID

ehrResourceIdstring

Filter by EHR resource ID

fhirStoreStatusstring

Filter by FHIR store status

Enum"UNMAPPED""MAPPED""IMPORTED""ERROR"
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""resourceType""ehrResourceName""subfolder""isActive""fhirStoreStatus""mappedAt""createdAt""updatedAt"
sortBy[0][dir]string

First sort direction

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

Second sort field

Enum"id""resourceType""ehrResourceName""subfolder""isActive""fhirStoreStatus""mappedAt""createdAt""updatedAt"
sortBy[1][dir]string

Second sort direction

Enum"asc""desc"
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>'

Responses

List of site FHIR mapping state records retrieved successfully.

Bodyapplication/json
dataArray of objects(SiteFhirMappingStateDto)required

Array of Site FHIR mapping state records

data[].​idnumberrequired

ID of the FhirMappingState record

Example: 1
data[].​siteIdnumberrequired

Site ID this record relates to

Example: 1
data[].​resourceTypestringrequired

Resource type

Example: "Organization"
data[].​ehrResourceNamestringrequired

EHR resource name

Example: "insurance_carrier"
data[].​ehrResourceIdstringrequired

EHR resource ID

Example: "19000021031362"
data[].​ehrResourceHashstring or null

EHR resource hash

Example: "9c973682474c2c7e"
data[].​subfolderstring or null

Subfolder

Example: "core"
data[].​sourceFilestring or null

Source file

Example: "synchronizer/20/collected/organization/20250731_151154_organization_20_data.json"
data[].​sourceFileHashstring or null

Source file hash

Example: "dc4383ab00e078ff"
data[].​isActiveboolean or null

False when the resource is not active (soft-deleted)

Example: true
data[].​fhirIdstring or null

FHIR ID

Example: "db33baca-c28e-4eba-af36-6b69e08dfb93"
data[].​fhirStoreStatusstring or null

FHIR store status

Example: "IMPORTED"
data[].​mappedAtstring or null(date-time)

Mapped at date

Example: "2025-08-06 13:58:20.735"
data[].​createdAtstring(date-time)required

Created at date

Example: "2025-08-06 13:58:23.625"
data[].​updatedAtstring(date-time)required

Updated at date

Example: "2025-08-06 13:58:23.625"
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
  }
}

Retrieve the list of distinct FHIR resource types for the given site ID

Request

Security
bearer
Path
siteIdnumberrequired
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>'

Responses

List of distinct FHIR resource types retrieved successfully.

Bodyapplication/jsonArray [
string
]
Response
application/json
[
  "string"
]

Codes

Operations

Periomeasure

Operations

Availability

Operations

Users

Operations

Billing Information

Operations