Delete a brand by ID

Site Appointment Types

Operations

Appointment Type

Operations

Brands

Operations

Retrieve all brands with optional filters

Request

Security

bearer

Query

titlestring

The title of the brand

Example: title=HeyDonto

organizationIdArray of numbers

The organizationId of the brand

Example: organizationId=1

clientAccountIdArray of numbers

The clientAccountId of the brand

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""organizationId""clientAccountId"

sortBy[0][dir]string

First sort direction

Enum"asc""desc"

sortBy[1][field]string

Second sort field

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

sortBy[1][dir]string

Second sort direction

Enum"asc""desc"

curl -i -X GET \
  'https://docs.heydonto.com/_mock/apis/heydonto/openapi/brands?title=HeyDonto&organizationId=1&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 brands retrieved successfully.

Bodyapplication/json

dataArray of objects(BrandDto)required

Array of brands

data[].idnumberrequired

The ID of the brand to be updated

Example: 456

data[].titlestringrequired

The title of the brand

Example: "HealthCorp"

data[].clientAccountIdnumberrequired

The client account id of the brand

Example: 1

data[].clientAccountobjectrequired

The client account of the brand

data[].clientAccount.idnumberrequired

The ID of the client account

Example: 123

data[].clientAccount.titlestringrequired

The title of the client account

Example: "Downtown Clinic"

data[].organizationobjectrequired

The organization the brand

data[].organization.idnumber

The ID of the organization the brand is associated with

Example: 123

data[].organization.titlestringrequired

The title of the organization the brand is associated with

Example: "HealthCorp"

data[].organization.clientAccountIdnumber

The ID of the client account the brand is associated with

Example: 123

data[].organization.websitestring

The website of the organization the brand is associated with

Example: "www.healthcorp.com"

data[].organization.isEnabledbooleanrequired

Indicates whether the organization is enabled

Example: true

data[].organization.createdAtstringrequired

The date and time the brand was created

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

data[].organization.updatedAtstringrequired

The date and time the brand was last updated

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

data[].sitesArray of objects(BrandSiteDto)required

The sites associated with the brand

data[].sites[].idnumberrequired

The ID of the site the brand is associated with

Example: 123

data[].sites[].namestringrequired

The name of the site

Example: "Downtown Clinic"

data[].sites[].addressobjectrequired

The address information of the site

data[].sites[].address.latnumberrequired

The latitude coordinate of the address

Example: 37.7749

data[].sites[].address.lngnumberrequired

The longitude coordinate of the address

Example: -122.4194

data[].sites[].address.urlstringrequired

The URL associated with the address

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

data[].sites[].address.formatted_addressstringrequired

The formatted address string

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

data[].sites[].googlePlaceIdstringrequired

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[].organizationIdnumberrequired

The ID of the organization the site belongs to

Example: 789

data[].sites[].clientAccountIdnumberrequired

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[].licenseKeystringrequired

The license key for the site

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

data[].sites[].fhirStoreIdstringrequired

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[].siteManagerUserIdnumberrequired

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[].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[].isEnabledbooleanrequired

Indicates whether the brand is enabled

Example: true

data[].createdAtstringrequired

The date and time the brand was created

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

data[].updatedAtstringrequired

The date and time the brand 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 brand

Request

Security

bearer

Bodyapplication/jsonrequired

titlestringrequired

The title of the brand

Example: "HealthCorp"

organizationIdnumber

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

Example: 123

isEnabledboolean

Indicates whether the brand 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/brands \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "HealthCorp",
    "organizationId": 123,
    "isEnabled": true,
    "clientAccountId": 123
  }'

Responses

Brand created successfully.

Bodyapplication/json

titlestringrequired

The title of the brand

Example: "HealthCorp"

organizationIdnumber

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

Example: 123

isEnabledboolean

Indicates whether the brand is enabled

Example: true

clientAccountIdnumberrequired

The ID of the client account

Example: 123

Response

application/json

{
  "title": "HealthCorp",
  "organizationId": 123,
  "isEnabled": true,
  "clientAccountId": 123
}

Retrieve all brands as a list (non-paginated) for dropdowns and selections

Request

Security

bearer

Query

clientAccountIdArray of stringsrequired

titlestringrequired

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

Responses

List of brands retrieved successfully.

Bodyapplication/jsonArray [

idnumberrequired

The ID of the brand to be updated

Example: 456

titlestringrequired

The title of the brand

Example: "HealthCorp"

clientAccountIdnumberrequired

The client account id of the brand

Example: 1

clientAccountobjectrequired

The client account of the brand

clientAccount.idnumberrequired

The ID of the client account

Example: 123

clientAccount.titlestringrequired

The title of the client account

Example: "Downtown Clinic"

organizationobjectrequired

The organization the brand

organization.idnumber

The ID of the organization the brand is associated with

Example: 123

organization.titlestringrequired

The title of the organization the brand is associated with

Example: "HealthCorp"

organization.clientAccountIdnumber

The ID of the client account the brand is associated with

Example: 123

organization.websitestring

The website of the organization the brand is associated with

Example: "www.healthcorp.com"

organization.isEnabledbooleanrequired

Indicates whether the organization is enabled

Example: true

organization.createdAtstringrequired

The date and time the brand was created

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

organization.updatedAtstringrequired

The date and time the brand was last updated

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

sitesArray of objects(BrandSiteDto)required

The sites associated with the brand

sites[].idnumberrequired

The ID of the site the brand is associated with

Example: 123

sites[].namestringrequired

The name of the site

Example: "Downtown Clinic"

sites[].addressobjectrequired

The address information of the site

sites[].address.latnumberrequired

The latitude coordinate of the address

Example: 37.7749

sites[].address.lngnumberrequired

The longitude coordinate of the address

Example: -122.4194

sites[].address.urlstringrequired

The URL associated with the address

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

sites[].address.formatted_addressstringrequired

The formatted address string

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

sites[].googlePlaceIdstringrequired

The Google Place ID for the site

Example: "ChIJN1t_tDeuEmsRUsoyG83frY4"

sites[].phoneNumberstring or null

The phone number of the site

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

sites[].websitestring or null

The website of the site

Example: "https://downtownclinic.com"

sites[].anyDeskIpstring or null

The AnyDesk IP address for remote access

Example: "192.168.1.100"

sites[].createdByUserIdnumberrequired

The ID of the user who created the site

Example: 456

sites[].createdAtstringrequired

The date and time the site was created

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

sites[].updatedAtstringrequired

The date and time the site was last updated

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

sites[].deletedAtstring or null

The date and time the site was deleted, if applicable

Example: null

sites[].organizationIdnumberrequired

The ID of the organization the site belongs to

Example: 789

sites[].clientAccountIdnumberrequired

The ID of the client account the site is associated with

Example: 101

sites[].brandIdnumberrequired

The ID of the brand the site is associated with

Example: 202

sites[].practiceManagementSystemIdnumberrequired

The ID of the practice management system used by the site

Example: 303

sites[].licenseKeystringrequired

The license key for the site

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

sites[].fhirStoreIdstringrequired

The ID of the FHIR store associated with the site

Example: "fhir-store-123"

sites[].firstSyncDatestring or null

The date of the first sync with the site

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

sites[].latestSyncDatestring or null

The date of the most recent sync with the site

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

sites[].siteManagerUserIdnumberrequired

The ID of the user who manages the site

Example: 505

sites[].cloudUserNamestring or null

The cloud username for the site

Example: "downtown.clinic"

sites[].cloudOrganizationNamestring or null

The name of the cloud organization for the site

Example: "HealthCorp Cloud"

sites[].cloudLoginUrlstring or null

The URL for cloud login

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

sites[].practiceManagementSystemobjectrequired

The practice management system used by the site

sites[].practiceManagementSystem.idnumberrequired

The ID of the practice management system

Example: 789

sites[].practiceManagementSystem.titlestringrequired

The title of the practice management system

Example: "MedicalSoft Pro"

sites[].practiceManagementSystem.isCloudBasedbooleanrequired

Indicates whether the system is cloud-based

Example: true

sites[].practiceManagementSystem.isEnabledbooleanrequired

Indicates whether the system is enabled

Example: true

sites[].practiceManagementSystem.createdAtstringrequired

The date and time the system was created

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

sites[].practiceManagementSystem.updatedAtstringrequired

The date and time the system was last updated

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

isEnabledbooleanrequired

Indicates whether the brand is enabled

Example: true

createdAtstringrequired

The date and time the brand was created

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

updatedAtstringrequired

The date and time the brand was last updated

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

]

Response

application/json

[
  {
    "id": 456,
    "title": "HealthCorp",
    "clientAccountId": 1,
    "clientAccount": { … },
    "organization": { … },
    "sites": [ … ],
    "isEnabled": true,
    "createdAt": "2021-05-01T12:00:00Z",
    "updatedAt": "2021-05-01T12:00:00Z"
  }
]

Retrieve a brand by ID

Request

Security

bearer

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

idnumberrequired

The ID of the brand to be updated

Example: 456

titlestringrequired

The title of the brand

Example: "HealthCorp"

clientAccountIdnumberrequired

The client account id of the brand

Example: 1

clientAccountobjectrequired

The client account of the brand

clientAccount.idnumberrequired

The ID of the client account

Example: 123

clientAccount.titlestringrequired

The title of the client account

Example: "Downtown Clinic"

organizationobjectrequired

The organization the brand

organization.idnumber

The ID of the organization the brand is associated with

Example: 123

organization.titlestringrequired

The title of the organization the brand is associated with

Example: "HealthCorp"

organization.clientAccountIdnumber

The ID of the client account the brand is associated with

Example: 123

organization.websitestring

The website of the organization the brand is associated with

Example: "www.healthcorp.com"

organization.isEnabledbooleanrequired

Indicates whether the organization is enabled

Example: true

organization.createdAtstringrequired

The date and time the brand was created

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

organization.updatedAtstringrequired

The date and time the brand was last updated

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

sitesArray of objects(BrandSiteDto)required

The sites associated with the brand

sites[].idnumberrequired

The ID of the site the brand is associated with

Example: 123

sites[].namestringrequired

The name of the site

Example: "Downtown Clinic"

sites[].addressobjectrequired

The address information of the site

sites[].address.latnumberrequired

The latitude coordinate of the address

Example: 37.7749

sites[].address.lngnumberrequired

The longitude coordinate of the address

Example: -122.4194

sites[].address.urlstringrequired

The URL associated with the address

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

sites[].address.formatted_addressstringrequired

The formatted address string

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

sites[].googlePlaceIdstringrequired

The Google Place ID for the site

Example: "ChIJN1t_tDeuEmsRUsoyG83frY4"

sites[].phoneNumberstring or null

The phone number of the site

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

sites[].websitestring or null

The website of the site

Example: "https://downtownclinic.com"

sites[].anyDeskIpstring or null

The AnyDesk IP address for remote access

Example: "192.168.1.100"

sites[].createdByUserIdnumberrequired

The ID of the user who created the site

Example: 456

sites[].createdAtstringrequired

The date and time the site was created

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

sites[].updatedAtstringrequired

The date and time the site was last updated

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

sites[].deletedAtstring or null

The date and time the site was deleted, if applicable

Example: null

sites[].organizationIdnumberrequired

The ID of the organization the site belongs to

Example: 789

sites[].clientAccountIdnumberrequired

The ID of the client account the site is associated with

Example: 101

sites[].brandIdnumberrequired

The ID of the brand the site is associated with

Example: 202

sites[].practiceManagementSystemIdnumberrequired

The ID of the practice management system used by the site

Example: 303

sites[].licenseKeystringrequired

The license key for the site

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

sites[].fhirStoreIdstringrequired

The ID of the FHIR store associated with the site

Example: "fhir-store-123"

sites[].firstSyncDatestring or null

The date of the first sync with the site

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

sites[].latestSyncDatestring or null

The date of the most recent sync with the site

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

sites[].siteManagerUserIdnumberrequired

The ID of the user who manages the site

Example: 505

sites[].cloudUserNamestring or null

The cloud username for the site

Example: "downtown.clinic"

sites[].cloudOrganizationNamestring or null

The name of the cloud organization for the site

Example: "HealthCorp Cloud"

sites[].cloudLoginUrlstring or null

The URL for cloud login

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

sites[].practiceManagementSystemobjectrequired

The practice management system used by the site

sites[].practiceManagementSystem.idnumberrequired

The ID of the practice management system

Example: 789

sites[].practiceManagementSystem.titlestringrequired

The title of the practice management system

Example: "MedicalSoft Pro"

sites[].practiceManagementSystem.isCloudBasedbooleanrequired

Indicates whether the system is cloud-based

Example: true

sites[].practiceManagementSystem.isEnabledbooleanrequired

Indicates whether the system is enabled

Example: true

sites[].practiceManagementSystem.createdAtstringrequired

The date and time the system was created

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

sites[].practiceManagementSystem.updatedAtstringrequired

The date and time the system was last updated

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

isEnabledbooleanrequired

Indicates whether the brand is enabled

Example: true

createdAtstringrequired

The date and time the brand was created

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

updatedAtstringrequired

The date and time the brand was last updated

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

Response

application/json

{
  "id": 456,
  "title": "HealthCorp",
  "clientAccountId": 1,
  "clientAccount": {
    "id": 123,
    "title": "Downtown Clinic"
  },
  "organization": {
    "id": 123,
    "title": "HealthCorp",
    "clientAccountId": 123,
    "website": "www.healthcorp.com",
    "isEnabled": true,
    "createdAt": "2021-05-01T12:00:00Z",
    "updatedAt": "2021-05-01T12:00:00Z"
  },
  "sites": [
    { … }
  ],
  "isEnabled": true,
  "createdAt": "2021-05-01T12:00:00Z",
  "updatedAt": "2021-05-01T12:00:00Z"
}

Update an existing brand

Request

Security

bearer

Path

brandIdnumberrequired

Bodyapplication/jsonrequired

titlestringrequired

The title of the brand

Example: "HealthCorp"

organizationIdnumber

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

Example: 123

isEnabledboolean

Indicates whether the brand 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/brands/{brandId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "title": "HealthCorp",
    "organizationId": 123,
    "isEnabled": true,
    "clientAccountId": 123
  }'

Responses

Brand updated successfully.

Bodyapplication/json

titlestringrequired

The title of the brand

Example: "HealthCorp"

organizationIdnumber

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

Example: 123

isEnabledboolean

Indicates whether the brand is enabled

Example: true

clientAccountIdnumberrequired

The ID of the client account

Example: 123

Response

application/json

{
  "title": "HealthCorp",
  "organizationId": 123,
  "isEnabled": true,
  "clientAccountId": 123
}