Appointment types

Get appointment types

get

Retrieves a list of appointment types based on the provided filter

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

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-types

HTTPcURLJavaScriptPython

GET /api/service-provider-scheduling/appointment-types 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",
    "priority": "HIGH",
    "description": "A brief consultation session",
    "durationInMinutes": 30,
    "appointmentTypeTemplateId": 1,
    "serviceProviderScheduleId": 2,
    "useDefaultAvailability": true,
    "overlappingSlots": true,
    "disabled": true,
    "externalId": "welkin-encounter-template",
    "schedulerSystemUserId": "user-123",
    "serviceProviderId": 1,
    "startDate": "2023-01-01T00:00:00Z",
    "endDate": "2023-12-31T23:59:59Z",
    "color": "#FF5733",
    "locationType": "GOOGLE_MAPS",
    "userId": "user-456",
    "user": {
      "id": "12345",
      "status": "active",
      "firstName": "John",
      "lastName": "Doe",
      "email": "[email protected]",
      "roles": [
        "admin",
        "user"
      ],
      "profilePic": "http://example.com/profile.jpg",
      "timeZone": "UTC",
      "attributes": {
        "key": "value"
      },
      "address": [
        {
          "street": "123 Main St",
          "city": "Anytown"
        }
      ],
      "organizationAddresses": [
        {
          "street": "456 Corporate Blvd",
          "city": "Businesstown"
        }
      ],
      "isGroup": true,
      "users": [],
      "displayTitle": "MD",
      "serviceProviderLicenseInfo": [
        {
          "stateOfIssuance": "CA",
          "country": "USA"
        }
      ],
      "partnerId": 1,
      "serviceableRadius": 1,
      "partner": {
        "id": 1,
        "organizationId": 1,
        "name": "text",
        "addressGroup": {
          "id": 12,
          "name": "Name",
          "description": "Lab",
          "region": "New York",
          "type": "LAB",
          "organizationId": 1,
          "active": true,
          "addressGroupMapping": [],
          "createdAt": "2023-01-01T00:00:00.000Z",
          "updatedAt": "2023-01-01T00:00:00.000Z",
          "addressMappingCount": 1
        },
        "addressGroupId": 1,
        "partnerTypeId": 1,
        "attributes": {},
        "partnerType": {
          "name": "Test Partner Type Name",
          "description": "Test Partner Type Description",
          "partnerType": "CUSTOM",
          "organizationId": 1,
          "active": true,
          "createdAt": "2025-01-01T00:00:00.000Z",
          "updatedAt": "2025-01-01T00:00:00.000Z"
        },
        "active": true,
        "createdAt": "2026-02-07",
        "updatedAt": "2026-02-07"
      }
    },
    "maximumAppointmentsPerDay": 10,
    "maximumAppointmentsPerWeek": 1,
    "serviceProviderRole": "CLIENT_MANAGER",
    "bookingHorizon": 30,
    "attributes": {},
    "addressGroupId": 1,
    "addressGroup": {}
  }
]

Create multiple appointment types

post

Creates multiple appointment types

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

idnumberOptional

namestringRequired

prioritystring · enumOptionalPossible values:

descriptionstringOptional

durationInMinutesnumberOptional

startDateone ofOptional

string · dateOptional

or

string · date-timeOptional

endDateone ofOptional

string · dateOptional

or

string · date-timeOptional

colorstringOptional

locationTypeanyOptional

userIdstringOptional

externalIdstringOptional

useDefaultAvailabilitybooleanOptional

disabledbooleanOptional

appointmentTypeTemplateIdnumberOptional

schedulerSystemUserIdstringOptional

serviceProviderIdnumberOptional

serviceProviderScheduleIdnumberOptional

serviceProviderScheduleanyOptional

maximumAppointmentsPerDaynumberOptional

maximumAppointmentsPerWeeknumberOptional

serviceProviderRoleanyOptional

Responses

200Success

application/json

post

/api/service-provider-scheduling/appointment-types

HTTPcURLJavaScriptPython

POST /api/service-provider-scheduling/appointment-types 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: 634

{
  "id": 1,
  "name": "text",
  "priority": "HIGH",
  "description": "text",
  "durationInMinutes": 1,
  "startDate": "2026-02-07",
  "endDate": "2026-02-07",
  "color": "text",
  "locationType": null,
  "userId": "text",
  "externalId": "text",
  "useDefaultAvailability": true,
  "disabled": true,
  "appointmentTypeTemplateId": 1,
  "schedulerSystemUserId": "text",
  "serviceProviderId": 1,
  "serviceProviderScheduleId": 1,
  "serviceProviderSchedule": null,
  "maximumAppointmentsPerDay": 1,
  "maximumAppointmentsPerWeek": 1,
  "serviceProviderRole": null,
  "appointmentTypeServiceProviders": [
    {
      "serviceProviderId": "12345",
      "serviceProviderRole": "Doctor",
      "serviceProviderScheduleId": 67890,
      "durationInMinutes": 30
    }
  ]
}

200Success

{
  "count": 10
}

Create appointment type

post

Creates a new appointment type for a specific service provider

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

Body

application/json

idnumberOptional

namestringRequired

prioritystring · enumOptionalPossible values:

descriptionstringOptional

durationInMinutesnumberOptional

startDateone ofOptional

string · dateOptional

or

string · date-timeOptional

endDateone ofOptional

string · dateOptional

or

string · date-timeOptional

colorstringOptional

locationTypeanyOptional

userIdstringOptional

externalIdstringOptional

useDefaultAvailabilitybooleanOptional

disabledbooleanOptional

appointmentTypeTemplateIdnumberOptional

schedulerSystemUserIdstringOptional

serviceProviderIdnumberOptional

serviceProviderScheduleIdnumberOptional

serviceProviderScheduleanyOptional

maximumAppointmentsPerDaynumberOptional

maximumAppointmentsPerWeeknumberOptional

serviceProviderRoleanyOptional

Responses

200Success

application/json

post

/api/service-provider-scheduling/{serviceProviderId}/appointment-types

HTTPcURLJavaScriptPython

POST /api/service-provider-scheduling/{serviceProviderId}/appointment-types 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: 634

{
  "id": 1,
  "name": "text",
  "priority": "HIGH",
  "description": "text",
  "durationInMinutes": 1,
  "startDate": "2026-02-07",
  "endDate": "2026-02-07",
  "color": "text",
  "locationType": null,
  "userId": "text",
  "externalId": "text",
  "useDefaultAvailability": true,
  "disabled": true,
  "appointmentTypeTemplateId": 1,
  "schedulerSystemUserId": "text",
  "serviceProviderId": 1,
  "serviceProviderScheduleId": 1,
  "serviceProviderSchedule": null,
  "maximumAppointmentsPerDay": 1,
  "maximumAppointmentsPerWeek": 1,
  "serviceProviderRole": null,
  "appointmentTypeServiceProviders": [
    {
      "serviceProviderId": "12345",
      "serviceProviderRole": "Doctor",
      "serviceProviderScheduleId": 67890,
      "durationInMinutes": 30
    }
  ]
}

200Success

{
  "id": "12345",
  "name": "Consultation",
  "priority": "HIGH",
  "description": "A brief consultation session",
  "durationInMinutes": 30,
  "appointmentTypeTemplateId": 1,
  "serviceProviderScheduleId": 2,
  "useDefaultAvailability": true,
  "overlappingSlots": true,
  "disabled": true,
  "externalId": "welkin-encounter-template",
  "schedulerSystemUserId": "user-123",
  "serviceProviderId": 1,
  "startDate": "2023-01-01T00:00:00Z",
  "endDate": "2023-12-31T23:59:59Z",
  "color": "#FF5733",
  "locationType": "GOOGLE_MAPS",
  "userId": "user-456",
  "user": {
    "id": "12345",
    "status": "active",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "roles": [
      "admin",
      "user"
    ],
    "profilePic": "http://example.com/profile.jpg",
    "timeZone": "UTC",
    "attributes": {
      "key": "value"
    },
    "address": [
      {
        "street": "123 Main St",
        "city": "Anytown"
      }
    ],
    "organizationAddresses": [
      {
        "street": "456 Corporate Blvd",
        "city": "Businesstown"
      }
    ],
    "isGroup": true,
    "users": [],
    "displayTitle": "MD",
    "serviceProviderLicenseInfo": [
      {
        "stateOfIssuance": "CA",
        "country": "USA"
      }
    ],
    "partnerId": 1,
    "serviceableRadius": 1,
    "partner": {
      "id": 1,
      "organizationId": 1,
      "name": "text",
      "addressGroup": {
        "id": 12,
        "name": "Name",
        "description": "Lab",
        "region": "New York",
        "type": "LAB",
        "organizationId": 1,
        "active": true,
        "addressGroupMapping": [],
        "createdAt": "2023-01-01T00:00:00.000Z",
        "updatedAt": "2023-01-01T00:00:00.000Z",
        "addressMappingCount": 1
      },
      "addressGroupId": 1,
      "partnerTypeId": 1,
      "attributes": {},
      "partnerType": {
        "name": "Test Partner Type Name",
        "description": "Test Partner Type Description",
        "partnerType": "CUSTOM",
        "organizationId": 1,
        "active": true,
        "createdAt": "2025-01-01T00:00:00.000Z",
        "updatedAt": "2025-01-01T00:00:00.000Z"
      },
      "active": true,
      "createdAt": "2026-02-07",
      "updatedAt": "2026-02-07"
    }
  },
  "maximumAppointmentsPerDay": 10,
  "maximumAppointmentsPerWeek": 1,
  "serviceProviderRole": "CLIENT_MANAGER",
  "bookingHorizon": 30,
  "attributes": {},
  "addressGroupId": 1,
  "addressGroup": {}
}

Update appointment type

put

Updates an existing appointment type for a specific service provider

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

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

Body

application/json

idnumberOptional

namestringRequired

prioritystring · enumOptionalPossible values:

descriptionstringOptional

durationInMinutesnumberOptional

startDateone ofOptional

string · dateOptional

or

string · date-timeOptional

endDateone ofOptional

string · dateOptional

or

string · date-timeOptional

colorstringOptional

locationTypeanyOptional

userIdstringOptional

externalIdstringOptional

useDefaultAvailabilitybooleanOptional

disabledbooleanOptional

appointmentTypeTemplateIdnumberOptional

schedulerSystemUserIdstringOptional

serviceProviderIdnumberOptional

serviceProviderScheduleIdnumberOptional

serviceProviderScheduleanyOptional

maximumAppointmentsPerDaynumberOptional

maximumAppointmentsPerWeeknumberOptional

serviceProviderRoleanyOptional

Responses

200Success

application/json

put

/api/service-provider-scheduling/{serviceProviderId}/appointment-types/{id}

HTTPcURLJavaScriptPython

PUT /api/service-provider-scheduling/{serviceProviderId}/appointment-types/{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: 634

{
  "id": 1,
  "name": "text",
  "priority": "HIGH",
  "description": "text",
  "durationInMinutes": 1,
  "startDate": "2026-02-07",
  "endDate": "2026-02-07",
  "color": "text",
  "locationType": null,
  "userId": "text",
  "externalId": "text",
  "useDefaultAvailability": true,
  "disabled": true,
  "appointmentTypeTemplateId": 1,
  "schedulerSystemUserId": "text",
  "serviceProviderId": 1,
  "serviceProviderScheduleId": 1,
  "serviceProviderSchedule": null,
  "maximumAppointmentsPerDay": 1,
  "maximumAppointmentsPerWeek": 1,
  "serviceProviderRole": null,
  "appointmentTypeServiceProviders": [
    {
      "serviceProviderId": "12345",
      "serviceProviderRole": "Doctor",
      "serviceProviderScheduleId": 67890,
      "durationInMinutes": 30
    }
  ]
}

200Success

{
  "id": "12345",
  "name": "Consultation",
  "priority": "HIGH",
  "description": "A brief consultation session",
  "durationInMinutes": 30,
  "appointmentTypeTemplateId": 1,
  "serviceProviderScheduleId": 2,
  "useDefaultAvailability": true,
  "overlappingSlots": true,
  "disabled": true,
  "externalId": "welkin-encounter-template",
  "schedulerSystemUserId": "user-123",
  "serviceProviderId": 1,
  "startDate": "2023-01-01T00:00:00Z",
  "endDate": "2023-12-31T23:59:59Z",
  "color": "#FF5733",
  "locationType": "GOOGLE_MAPS",
  "userId": "user-456",
  "user": {
    "id": "12345",
    "status": "active",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "roles": [
      "admin",
      "user"
    ],
    "profilePic": "http://example.com/profile.jpg",
    "timeZone": "UTC",
    "attributes": {
      "key": "value"
    },
    "address": [
      {
        "street": "123 Main St",
        "city": "Anytown"
      }
    ],
    "organizationAddresses": [
      {
        "street": "456 Corporate Blvd",
        "city": "Businesstown"
      }
    ],
    "isGroup": true,
    "users": [],
    "displayTitle": "MD",
    "serviceProviderLicenseInfo": [
      {
        "stateOfIssuance": "CA",
        "country": "USA"
      }
    ],
    "partnerId": 1,
    "serviceableRadius": 1,
    "partner": {
      "id": 1,
      "organizationId": 1,
      "name": "text",
      "addressGroup": {
        "id": 12,
        "name": "Name",
        "description": "Lab",
        "region": "New York",
        "type": "LAB",
        "organizationId": 1,
        "active": true,
        "addressGroupMapping": [],
        "createdAt": "2023-01-01T00:00:00.000Z",
        "updatedAt": "2023-01-01T00:00:00.000Z",
        "addressMappingCount": 1
      },
      "addressGroupId": 1,
      "partnerTypeId": 1,
      "attributes": {},
      "partnerType": {
        "name": "Test Partner Type Name",
        "description": "Test Partner Type Description",
        "partnerType": "CUSTOM",
        "organizationId": 1,
        "active": true,
        "createdAt": "2025-01-01T00:00:00.000Z",
        "updatedAt": "2025-01-01T00:00:00.000Z"
      },
      "active": true,
      "createdAt": "2026-02-07",
      "updatedAt": "2026-02-07"
    }
  },
  "maximumAppointmentsPerDay": 10,
  "maximumAppointmentsPerWeek": 1,
  "serviceProviderRole": "CLIENT_MANAGER",
  "bookingHorizon": 30,
  "attributes": {},
  "addressGroupId": 1,
  "addressGroup": {}
}

Delete appointment type

delete

Deletes an appointment type for a specific service provider

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

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

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

Responses

200Success

application/json

delete

/api/service-provider-scheduling/{serviceProviderId}/appointment-types/{id}

HTTPcURLJavaScriptPython

DELETE /api/service-provider-scheduling/{serviceProviderId}/appointment-types/{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",
  "priority": "HIGH",
  "description": "A brief consultation session",
  "durationInMinutes": 30,
  "appointmentTypeTemplateId": 1,
  "serviceProviderScheduleId": 2,
  "useDefaultAvailability": true,
  "overlappingSlots": true,
  "disabled": true,
  "externalId": "welkin-encounter-template",
  "schedulerSystemUserId": "user-123",
  "serviceProviderId": 1,
  "startDate": "2023-01-01T00:00:00Z",
  "endDate": "2023-12-31T23:59:59Z",
  "color": "#FF5733",
  "locationType": "GOOGLE_MAPS",
  "userId": "user-456",
  "user": {
    "id": "12345",
    "status": "active",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "roles": [
      "admin",
      "user"
    ],
    "profilePic": "http://example.com/profile.jpg",
    "timeZone": "UTC",
    "attributes": {
      "key": "value"
    },
    "address": [
      {
        "street": "123 Main St",
        "city": "Anytown"
      }
    ],
    "organizationAddresses": [
      {
        "street": "456 Corporate Blvd",
        "city": "Businesstown"
      }
    ],
    "isGroup": true,
    "users": [],
    "displayTitle": "MD",
    "serviceProviderLicenseInfo": [
      {
        "stateOfIssuance": "CA",
        "country": "USA"
      }
    ],
    "partnerId": 1,
    "serviceableRadius": 1,
    "partner": {
      "id": 1,
      "organizationId": 1,
      "name": "text",
      "addressGroup": {
        "id": 12,
        "name": "Name",
        "description": "Lab",
        "region": "New York",
        "type": "LAB",
        "organizationId": 1,
        "active": true,
        "addressGroupMapping": [],
        "createdAt": "2023-01-01T00:00:00.000Z",
        "updatedAt": "2023-01-01T00:00:00.000Z",
        "addressMappingCount": 1
      },
      "addressGroupId": 1,
      "partnerTypeId": 1,
      "attributes": {},
      "partnerType": {
        "name": "Test Partner Type Name",
        "description": "Test Partner Type Description",
        "partnerType": "CUSTOM",
        "organizationId": 1,
        "active": true,
        "createdAt": "2025-01-01T00:00:00.000Z",
        "updatedAt": "2025-01-01T00:00:00.000Z"
      },
      "active": true,
      "createdAt": "2026-02-07",
      "updatedAt": "2026-02-07"
    }
  },
  "maximumAppointmentsPerDay": 10,
  "maximumAppointmentsPerWeek": 1,
  "serviceProviderRole": "CLIENT_MANAGER",
  "bookingHorizon": 30,
  "attributes": {},
  "addressGroupId": 1,
  "addressGroup": {}
}