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

Retrieve all brands with optional filters (ADMIN)

Request

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

Responses

List of brands retrieved successfully.

Bodyapplication/jsonArray [
titlestringrequired

The title of the brand

Example: "HealthCorp"
organizationTitlestring

The title of the organization the brand is associated with (if applicable)

Example: "Global Health Group"
organizationIdnumber

The ID of the organization the brand is associated with (if applicable)

Example: 123
isAddingNewOrganizationboolean

Indicates whether a new organization is being added for the brand

Example: true
isEnabledboolean

Indicates whether the brand is enabled

Example: true
]
Response
application/json
[
  {
    "title": "HealthCorp",
    "organizationTitle": "Global Health Group",
    "organizationId": 123,
    "isAddingNewOrganization": true,
    "isEnabled": true
  }
]

Create a new brand

Request

Bodyapplication/jsonrequired
titlestringrequired

The title of the brand

Example: "HealthCorp"
organizationTitlestring

The title of the organization the brand is associated with (if applicable)

Example: "Global Health Group"
organizationIdnumber

The ID of the organization the brand is associated with (if applicable)

Example: 123
isAddingNewOrganizationboolean

Indicates whether a new organization is being added for the brand

Example: true
isEnabledboolean

Indicates whether the brand is enabled

Example: true
curl -i -X POST \
  https://docs.heydonto.com/_mock/apis/heydonto/openapi/brands \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "HealthCorp",
    "organizationTitle": "Global Health Group",
    "organizationId": 123,
    "isAddingNewOrganization": true,
    "isEnabled": true
  }'

Responses

Brand created successfully.

Bodyapplication/json
titlestringrequired

The title of the brand

Example: "HealthCorp"
organizationTitlestring

The title of the organization the brand is associated with (if applicable)

Example: "Global Health Group"
organizationIdnumber

The ID of the organization the brand is associated with (if applicable)

Example: 123
isAddingNewOrganizationboolean

Indicates whether a new organization is being added for the brand

Example: true
isEnabledboolean

Indicates whether the brand is enabled

Example: true
Response
application/json
{
  "title": "HealthCorp",
  "organizationTitle": "Global Health Group",
  "organizationId": 123,
  "isAddingNewOrganization": true,
  "isEnabled": true
}

Retrieve a brand by ID

Request

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

Responses

Brand retrieved successfully.

Bodyapplication/json
titlestringrequired

The title of the brand

Example: "HealthCorp"
organizationTitlestring

The title of the organization the brand is associated with (if applicable)

Example: "Global Health Group"
organizationIdnumber

The ID of the organization the brand is associated with (if applicable)

Example: 123
isAddingNewOrganizationboolean

Indicates whether a new organization is being added for the brand

Example: true
isEnabledboolean

Indicates whether the brand is enabled

Example: true
Response
application/json
{
  "title": "HealthCorp",
  "organizationTitle": "Global Health Group",
  "organizationId": 123,
  "isAddingNewOrganization": true,
  "isEnabled": true
}

Update an existing brand

Request

Path
brandIdnumberrequired
Bodyapplication/jsonrequired
titlestringrequired

The title of the brand

Example: "HealthCorp"
organizationTitlestring

The title of the organization the brand is associated with (if applicable)

Example: "Global Health Group"
organizationIdnumber

The ID of the organization the brand is associated with (if applicable)

Example: 123
isAddingNewOrganizationboolean

Indicates whether a new organization is being added for the brand

Example: true
isEnabledboolean

Indicates whether the brand is enabled

Example: true
idnumberrequired

The ID of the brand to be updated

Example: 456
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/brands/{brandId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "HealthCorp",
    "organizationTitle": "Global Health Group",
    "organizationId": 123,
    "isAddingNewOrganization": true,
    "isEnabled": true,
    "id": 456
  }'

Responses

Brand updated successfully.

Bodyapplication/json
titlestringrequired

The title of the brand

Example: "HealthCorp"
organizationTitlestring

The title of the organization the brand is associated with (if applicable)

Example: "Global Health Group"
organizationIdnumber

The ID of the organization the brand is associated with (if applicable)

Example: 123
isAddingNewOrganizationboolean

Indicates whether a new organization is being added for the brand

Example: true
isEnabledboolean

Indicates whether the brand is enabled

Example: true
idnumberrequired

The ID of the brand to be updated

Example: 456
Response
application/json
{
  "title": "HealthCorp",
  "organizationTitle": "Global Health Group",
  "organizationId": 123,
  "isAddingNewOrganization": true,
  "isEnabled": true,
  "id": 456
}

Delete a brand by ID

Request

Path
brandIdnumberrequired
curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/brands/{brandId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Brand deleted successfully.

Response
No content

Dental Practices

Operations

Dental Services

Operations

Organizations

Operations

Practice Management Systems

Operations

Sites

Operations

Codes

Operations

Site Assistants

Operations

Periomeasure

Operations

Availability

Operations