Delete an organization

Site Appointment Types

Operations

Appointment Type

Operations

Brands

Operations

Dental Practices

Operations

Dental Services

Operations

Organizations

Operations

Retrieve all organizations with optional filters

Request

Security

bearer

Query

titlestring

The title of the organization

Example: title=HealthCorp

isEnabledboolean

Filter by enabled status

Example: isEnabled=true

clientAccountIdArray of numbers

The clientAccountId of the organization

Example: clientAccountId=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""title""isEnabled""createdAt""updatedAt""clientAccountId"

sortBy[0][dir]string

First sort direction

Enum"asc""desc"

sortBy[1][field]string

Second sort field

Enum"id""title""isEnabled""createdAt""updatedAt""clientAccountId"

sortBy[1][dir]string

Second sort direction

Enum"asc""desc"

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/organization?title=HealthCorp&isEnabled=true&clientAccountId=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 organizations retrieved successfully.

Bodyapplication/json

dataArray of objects(OrganizationDto)required

Array of organizations

data[].idnumberrequired

The ID of the organization

Example: 123

data[].titlestringrequired

The title of the organization

Example: "HealthCorp"

data[].websitestring or null

The website of the organization

Example: "https://healthcorp.com"

data[].isEnabledbooleanrequired

Indicates whether the organization is enabled

Example: true

data[].clientAccountIdnumber or null

The ID of the client account the organization is associated with

Example: 456

data[].clientAccountobject or null

The client account associated with the organization

data[].sitesArray of objects(OrganizationSiteDto)required

The sites associated with the organization

data[].sites[].idnumberrequired

The ID of the site

Example: 123

data[].sites[].namestringrequired

The name of the site

Example: "Downtown Clinic"

data[].sites[].addressobject or null

The address information of the site

data[].sites[].googlePlaceIdstring or null

The Google Place ID for the site

Example: "ChIJN1t_tDeuEmsRUsoyG83frY4"

data[].sites[].phoneNumberstring or null

The phone number of the site

Example: "+1 (555) 123-4567"

data[].sites[].websitestring or null

The website of the site

Example: "https://downtownclinic.com"

data[].sites[].anyDeskIpstring or null

The AnyDesk IP address for remote access

Example: "192.168.1.100"

data[].sites[].createdByUserIdnumberrequired

The ID of the user who created the site

Example: 456

data[].sites[].createdAtstringrequired

The date and time the site was created

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

data[].sites[].updatedAtstringrequired

The date and time the site was last updated

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

data[].sites[].deletedAtstring or null

The date and time the site was deleted, if applicable

Example: null

data[].sites[].clientAccountIdnumber or null

The ID of the client account the site is associated with

Example: 101

data[].sites[].brandIdnumberrequired

The ID of the brand the site is associated with

Example: 202

data[].sites[].practiceManagementSystemIdnumberrequired

The ID of the practice management system used by the site

Example: 303

data[].sites[].licenseKeystring or null

The license key for the site

Example: "XXX-YYY-ZZZ-AAA-BBB"

data[].sites[].fhirStoreIdstring or null

The ID of the FHIR store associated with the site

Example: "fhir-store-123"

data[].sites[].firstSyncDatestring or null

The date of the first sync with the site

Example: "2021-05-15T12:00:00Z"

data[].sites[].latestSyncDatestring or null

The date of the most recent sync with the site

Example: "2021-06-01T12:00:00Z"

data[].sites[].synchronizationIsActiveboolean or null

Indicates whether synchronization is active

Example: true

data[].sites[].siteManagerUserIdnumber or null

The ID of the user who manages the site

Example: 505

data[].sites[].cloudUserNamestring or null

The cloud username for the site

Example: "downtown.clinic"

data[].sites[].cloudUserPasswordstring or null

The cloud user password for the site

Example: "encrypted-password"

data[].sites[].cloudOrganizationNamestring or null

The name of the cloud organization for the site

Example: "HealthCorp Cloud"

data[].sites[].cloudLoginUrlstring or null

The URL for cloud login

Example: "https://cloud.healthcorp.com/login"

data[].sites[].practiceManagementSystemobjectrequired

The practice management system used by the site

data[].sites[].practiceManagementSystem.idnumberrequired

The ID of the practice management system

Example: 789

data[].sites[].practiceManagementSystem.titlestringrequired

The title of the practice management system

Example: "MedicalSoft Pro"

data[].sites[].practiceManagementSystem.isCloudBasedbooleanrequired

Indicates whether the system is cloud-based

Example: true

data[].sites[].practiceManagementSystem.isEnabledbooleanrequired

Indicates whether the system is enabled

Example: true

data[].sites[].practiceManagementSystem.createdAtstringrequired

The date and time the system was created

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

data[].sites[].practiceManagementSystem.updatedAtstringrequired

The date and time the system was last updated

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

data[].brandsArray of objects(OrganizationBrandDto)required

The brands associated with the organization

data[].brands[].idnumberrequired

The ID of the brand

Example: 123

data[].brands[].titlestringrequired

The title of the brand

Example: "HealthCorp"

data[].brands[].clientAccountIdnumber or null

The ID of the client account the brand is associated with

Example: 456

data[].brands[].isEnabledbooleanrequired

Indicates whether the brand is enabled

Example: true

data[].brands[].createdAtstringrequired

The date and time the brand was created

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

data[].brands[].updatedAtstringrequired

The date and time the brand was last updated

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

data[].createdAtstringrequired

The date and time the organization was created

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

data[].updatedAtstringrequired

The date and time the organization was last updated

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

metaobjectrequired

Pagination metadata

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 organization

Request

Security

bearer

Bodyapplication/jsonrequired

titlestringrequired

The title of the organization

Example: "HealthCorp"

websitestringrequired

The website of the organization

Example: "https://heydonto.com"

isEnabledboolean

Indicates whether the organization is enabled

Example: true

clientAccountIdnumberrequired

The ID of the client account

Example: 123

curl -i -X POST \
  https://docs.heydonto.com/_mock/apis/heydonto/openapi/organization \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "HealthCorp",
    "website": "https://heydonto.com",
    "isEnabled": true,
    "clientAccountId": 123
  }'

Responses

Organization created successfully.

Bodyapplication/json

titlestringrequired

The title of the organization

Example: "HealthCorp"

websitestringrequired

The website of the organization

Example: "https://heydonto.com"

isEnabledboolean

Indicates whether the organization is enabled

Example: true

clientAccountIdnumberrequired

The ID of the client account

Example: 123

Response

application/json

{
  "title": "HealthCorp",
  "website": "https://heydonto.com",
  "isEnabled": true,
  "clientAccountId": 123
}

Retrieve an organization by ID

Request

Security

bearer

Path

organizationIdnumberrequired

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/organization/{organizationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Organization retrieved successfully.

Bodyapplication/json

titlestringrequired

The title of the organization

Example: "HealthCorp"

websitestringrequired

The website of the organization

Example: "https://heydonto.com"

isEnabledboolean

Indicates whether the organization is enabled

Example: true

clientAccountIdnumberrequired

The ID of the client account

Example: 123

Response

application/json

{
  "title": "HealthCorp",
  "website": "https://heydonto.com",
  "isEnabled": true,
  "clientAccountId": 123
}

Update an existing organization

Request

Security

bearer

Path

organizationIdnumberrequired

Bodyapplication/jsonrequired

titlestringrequired

The title of the organization

Example: "HealthCorp"

websitestringrequired

The website of the organization

Example: "https://heydonto.com"

isEnabledboolean

Indicates whether the organization is enabled

Example: true

clientAccountIdnumberrequired

The ID of the client account

Example: 123

curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/organization/{organizationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "HealthCorp",
    "website": "https://heydonto.com",
    "isEnabled": true,
    "clientAccountId": 123
  }'

Responses

Organization updated successfully.

Bodyapplication/json

titlestringrequired

The title of the organization

Example: "HealthCorp"

websitestringrequired

The website of the organization

Example: "https://heydonto.com"

isEnabledboolean

Indicates whether the organization is enabled

Example: true

clientAccountIdnumberrequired

The ID of the client account

Example: 123

Response

application/json

{
  "title": "HealthCorp",
  "website": "https://heydonto.com",
  "isEnabled": true,
  "clientAccountId": 123
}