Appointment type templates

Get appointment type templates

get

Retrieves all appointment type templates

Authorizations

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

regionstringOptional

organizationIdnumberOptional

isServiceProviderGroupbooleanOptional

byCareTeambooleanOptional

patientIdstringOptional

isTemplatebooleanOptional

includeAddressGroupbooleanOptional

Responses

200Success

application/json

get

/api/service-provider-scheduling/appointment-type-templates

GET /api/service-provider-scheduling/appointment-type-templates HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "12345",
    "name": "Consultation",
    "description": "A detailed consultation appointment",
    "priority": "HIGH",
    "durationInMinutes": 30,
    "startDate": "2023-01-01T00:00:00Z",
    "endDate": "2023-12-31T23:59:59Z",
    "disabled": true,
    "color": "#FF5733",
    "externalId": "ext-12345",
    "locationType": "GOOGLE_MAPS",
    "organizationId": 1,
    "templateName": "Standard Template",
    "type": "Medical",
    "attributes": {
      "key": "value"
    },
    "maximumAppointmentsPerDay": 10,
    "maximumAppointmentsPerWeek": 10,
    "minTimeBeforeBookingInMinutes": 60,
    "roleConfigurations": [],
    "addressGroupId": 1,
    "addressGroup": {},
    "organizationActions": {},
    "useDefaultAvailability": null,
    "overlappingSlots": null,
    "policyCategories": []
  }
]

Create appointment type template

post

Creates a new appointment type template

Authorizations

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

idnumberOptional

namestringOptional

prioritystring · enumOptionalPossible values:

descriptionstringOptional

durationInMinutesnumberOptional

startDateone ofOptional

string · dateOptional

string · date-timeOptional

endDateone ofOptional

string · dateOptional

string · date-timeOptional

colorstringOptional

externalIdstringOptional

typestringOptional

organizationIdnumberOptional

minTimeBeforeBookingInMinutesnumberOptional

maximumAppointmentsPerDaynumberOptional

maximumAppointmentsPerWeeknumberOptional

attributesobjectOptional

locationTypestring · enumOptionalPossible values:

addressGroupIdnumberOptional

useDefaultAvailabilityanyOptional

overlappingSlotsanyOptional

Responses

200Success

application/json

post

/api/service-provider-scheduling/appointment-type-templates

POST /api/service-provider-scheduling/appointment-type-templates HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 430

{
  "id": 1,
  "name": "text",
  "priority": "HIGH",
  "description": "text",
  "durationInMinutes": 1,
  "startDate": "2025-12-15",
  "endDate": "2025-12-15",
  "color": "text",
  "externalId": "text",
  "type": "text",
  "organizationId": 1,
  "minTimeBeforeBookingInMinutes": 1,
  "maximumAppointmentsPerDay": 1,
  "maximumAppointmentsPerWeek": 1,
  "attributes": {},
  "locationType": "NONE",
  "addressGroupId": 1,
  "organizationActions": [],
  "useDefaultAvailability": null,
  "overlappingSlots": null
}

200Success

{
  "id": "12345",
  "name": "Consultation",
  "description": "A detailed consultation appointment",
  "priority": "HIGH",
  "durationInMinutes": 30,
  "startDate": "2023-01-01T00:00:00Z",
  "endDate": "2023-12-31T23:59:59Z",
  "disabled": true,
  "color": "#FF5733",
  "externalId": "ext-12345",
  "locationType": "GOOGLE_MAPS",
  "organizationId": 1,
  "templateName": "Standard Template",
  "type": "Medical",
  "attributes": {
    "key": "value"
  },
  "maximumAppointmentsPerDay": 10,
  "maximumAppointmentsPerWeek": 10,
  "minTimeBeforeBookingInMinutes": 60,
  "roleConfigurations": [],
  "addressGroupId": 1,
  "addressGroup": {},
  "organizationActions": {},
  "useDefaultAvailability": null,
  "overlappingSlots": null,
  "policyCategories": []
}

Get appointment type template by ID

get

Retrieves a specific appointment type template

Authorizations

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

appointmentTypeTemplateIdstringRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

get

/api/service-provider-scheduling/appointment-type-templates/{appointmentTypeTemplateId}

GET /api/service-provider-scheduling/appointment-type-templates/{appointmentTypeTemplateId} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "12345",
  "name": "Consultation",
  "description": "A detailed consultation appointment",
  "priority": "HIGH",
  "durationInMinutes": 30,
  "startDate": "2023-01-01T00:00:00Z",
  "endDate": "2023-12-31T23:59:59Z",
  "disabled": true,
  "color": "#FF5733",
  "externalId": "ext-12345",
  "locationType": "GOOGLE_MAPS",
  "organizationId": 1,
  "templateName": "Standard Template",
  "type": "Medical",
  "attributes": {
    "key": "value"
  },
  "maximumAppointmentsPerDay": 10,
  "maximumAppointmentsPerWeek": 10,
  "minTimeBeforeBookingInMinutes": 60,
  "roleConfigurations": [],
  "addressGroupId": 1,
  "addressGroup": {},
  "organizationActions": {},
  "useDefaultAvailability": null,
  "overlappingSlots": null,
  "policyCategories": []
}

Update appointment type template

put

Updates an existing appointment type template

Authorizations

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

idstringRequiredPattern: [^\/#\?]+?

Body

idnumberOptional

namestringOptional

prioritystring · enumOptionalPossible values:

descriptionstringOptional

durationInMinutesnumberOptional

startDateone ofOptional

string · dateOptional

string · date-timeOptional

endDateone ofOptional

string · dateOptional

string · date-timeOptional

colorstringOptional

externalIdstringOptional

typestringOptional

organizationIdnumberOptional

minTimeBeforeBookingInMinutesnumberOptional

maximumAppointmentsPerDaynumberOptional

maximumAppointmentsPerWeeknumberOptional

attributesobjectOptional

locationTypestring · enumOptionalPossible values:

addressGroupIdnumberOptional

useDefaultAvailabilityanyOptional

overlappingSlotsanyOptional

Responses

200Success

application/json

put

/api/service-provider-scheduling/appointment-type-templates/{id}

PUT /api/service-provider-scheduling/appointment-type-templates/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 430

{
  "id": 1,
  "name": "text",
  "priority": "HIGH",
  "description": "text",
  "durationInMinutes": 1,
  "startDate": "2025-12-15",
  "endDate": "2025-12-15",
  "color": "text",
  "externalId": "text",
  "type": "text",
  "organizationId": 1,
  "minTimeBeforeBookingInMinutes": 1,
  "maximumAppointmentsPerDay": 1,
  "maximumAppointmentsPerWeek": 1,
  "attributes": {},
  "locationType": "NONE",
  "addressGroupId": 1,
  "organizationActions": [],
  "useDefaultAvailability": null,
  "overlappingSlots": null
}

200Success

{
  "id": "12345",
  "name": "Consultation",
  "description": "A detailed consultation appointment",
  "priority": "HIGH",
  "durationInMinutes": 30,
  "startDate": "2023-01-01T00:00:00Z",
  "endDate": "2023-12-31T23:59:59Z",
  "disabled": true,
  "color": "#FF5733",
  "externalId": "ext-12345",
  "locationType": "GOOGLE_MAPS",
  "organizationId": 1,
  "templateName": "Standard Template",
  "type": "Medical",
  "attributes": {
    "key": "value"
  },
  "maximumAppointmentsPerDay": 10,
  "maximumAppointmentsPerWeek": 10,
  "minTimeBeforeBookingInMinutes": 60,
  "roleConfigurations": [],
  "addressGroupId": 1,
  "addressGroup": {},
  "organizationActions": {},
  "useDefaultAvailability": null,
  "overlappingSlots": null,
  "policyCategories": []
}

Delete appointment type template

delete

Deletes a specific appointment type template

Authorizations

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

idstringRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

delete

/api/service-provider-scheduling/appointment-type-templates/{id}

DELETE /api/service-provider-scheduling/appointment-type-templates/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "12345",
  "name": "Consultation",
  "description": "A detailed consultation appointment",
  "priority": "HIGH",
  "durationInMinutes": 30,
  "startDate": "2023-01-01T00:00:00Z",
  "endDate": "2023-12-31T23:59:59Z",
  "disabled": true,
  "color": "#FF5733",
  "externalId": "ext-12345",
  "locationType": "GOOGLE_MAPS",
  "organizationId": 1,
  "templateName": "Standard Template",
  "type": "Medical",
  "attributes": {
    "key": "value"
  },
  "maximumAppointmentsPerDay": 10,
  "maximumAppointmentsPerWeek": 10,
  "minTimeBeforeBookingInMinutes": 60,
  "roleConfigurations": [],
  "addressGroupId": 1,
  "addressGroup": {},
  "organizationActions": {},
  "useDefaultAvailability": null,
  "overlappingSlots": null,
  "policyCategories": []
}

PreviousUnavailabilities NextValid