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

Retrieve all organizations with optional filters (ADMIN)

Request

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

Responses

List of organizations retrieved successfully.

Bodyapplication/jsonArray [
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
]
Response
application/json
[
  {
    "title": "HealthCorp",
    "website": "https://heydonto.com",
    "isEnabled": true
  }
]

Create a new organization

Request

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
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
  }'

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
Response
application/json
{
  "title": "HealthCorp",
  "website": "https://heydonto.com",
  "isEnabled": true
}

Retrieve an organization by ID

Request

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
Response
application/json
{
  "title": "HealthCorp",
  "website": "https://heydonto.com",
  "isEnabled": true
}

Update an existing organization

Request

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
idnumberrequired

The ID of the organization to be updated

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,
    "id": 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
idnumberrequired

The ID of the organization to be updated

Example: 123
Response
application/json
{
  "title": "HealthCorp",
  "website": "https://heydonto.com",
  "isEnabled": true,
  "id": 123
}

Delete an organization

Request

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

Responses

Organization deleted successfully.

Response
No content

Practice Management Systems

Operations

Sites

Operations

Codes

Operations

Site Assistants

Operations

Periomeasure

Operations

Availability

Operations