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

Sites

Operations

Codes

Operations

Site Assistants

Operations

Periomeasure

Operations

Availability

Operations

Users

Operations

Retrieve a list of users

Request

Security
bearer
Query
clientAccountIdArray of strings

Filter by client account ID

userRolestringrequired

The role of the user

Enum"ADMIN""ORGANIZATION_USER""BRAND_USER""SITE_USER""CLIENT_ACCOUNT_USER""SITE_MANAGER_USER"
Example: userRole=ADMIN
curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/users?clientAccountId=string&userRole=ADMIN' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Returns an array of users.

Create a new user

Request

Security
bearer
Bodyapplication/jsonrequired
emailstringrequired

The email of the user

Example: "john.doe@example.com"
firstNamestringrequired

The first name of the user

Example: "John"
lastNamestringrequired

The last name of the user

Example: "Doe"
passwordstringwrite-onlyrequired

The password of the user

Example: "password123"
isEnabledboolean

Indicates if the user is enabled

Example: true
organizationIdnumber

The organization ID

Example: 1
brandIdnumber

The brand ID

Example: 1
siteIdnumber

The site ID

Example: 1
rolestringrequired

The role of the user

Enum"ADMIN""ORGANIZATION_USER""BRAND_USER""SITE_USER""CLIENT_ACCOUNT_USER""SITE_MANAGER_USER"
Example: "ADMIN"
clientAccountIdArray of numbersrequired

List of client account IDs

Example: [1,2,3]
curl -i -X POST \
  https://docs.heydonto.com/_mock/apis/heydonto/openapi/users \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "password": "password123",
    "isEnabled": true,
    "organizationId": 1,
    "brandId": 1,
    "siteId": 1,
    "role": "ADMIN",
    "clientAccountId": [
      1,
      2,
      3
    ]
  }'

Responses

The user has been successfully created by admin.

Update a user

Request

Security
bearer
Path
userIdnumberrequired
Bodyapplication/jsonrequired
emailstringrequired

The email of the user

Example: "john.doe@example.com"
firstNamestringrequired

The first name of the user

Example: "John"
lastNamestringrequired

The last name of the user

Example: "Doe"
isEnabledboolean

Indicates if the user is enabled

Example: true
rolestringrequired

The role of the user

Enum"ADMIN""ORGANIZATION_USER""BRAND_USER""SITE_USER""CLIENT_ACCOUNT_USER""SITE_MANAGER_USER"
Example: "ADMIN"
clientAccountIdArray of numbersrequired

List of client account IDs

Example: [1,2,3]
curl -i -X PUT \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/users/{userId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "john.doe@example.com",
    "firstName": "John",
    "lastName": "Doe",
    "isEnabled": true,
    "role": "ADMIN",
    "clientAccountId": [
      1,
      2,
      3
    ]
  }'

Responses

The user has been successfully updated.

Delete a user

Request

Security
bearer
Path
userIdnumberrequired
curl -i -X DELETE \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/users/{userId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The user has been successfully deleted.

Billing Information

Operations