Appointment Type
An appointment type is a type of appointment that a patient that can book with you.
The appointment type model
Properties
- Name
id- Type
- string
- Description
Unique identifier for the appointment type.
- Name
object- Type
- string
- Description
Always 'appointment_type'.
- Name
name- Type
- string
- Description
Name of the appointment type.
- Name
description- Type
- string
- Description
Description of the appointment type.
- Name
duration- Type
- number
- Description
Duration of the appointment type.
- Name
group- Type
- boolean
- Description
Whether this is a group appointment.
- Name
max_participants- Type
- number
- Description
Only applies if this is a group appointment. Max number of participants allowed in appointments of this appointment type.
- Name
charge_while_booking- Type
- object
- Description
- Amount to charge the patient when they are booking an appointment of this appointment type
- Name
charge_after_appointment- Type
- object
- Description
- Amount to charge the patient once appointments of this appointment type is successfully completed
- Name
settings- Type
- object
- Description
- Settings for the appointment type.
- Name
created_by- Type
- string
- Description
Creator of the appointment type.
- Name
created_at- Type
- number
- Description
Timestamp (in ISO 8601 format) of when the appointment type was created.
- Name
last_updated_at- Type
- number
- Description
Timestamp (in ISO 8601 format) of when the appointment type was last updated.
Response
{
"id": "aptp_3XxtAULYUrX7GVsTKePy",
"object": "appointment_type",
"name": "Annual Check-in",
"description": "Annual check-in appointment for all patients",
"duration": 30,
"group": false,
"charge_while_booking": {
"enabled": true,
"auto_charge_if_possible": true,
"product": "prod_3XxtAULYUrX7GVsTKePy",
},
"charge_after_appointment": {
"enabled": false
},
"settings": {
"bookable_by_patient": true,
"required_buffer": 30,
"specific_license_types_required": true,
"license_types_required": ["MD"],
"care_team_required": false,
},
"created_by": "user_xeDpGyt67wTor93qKtS7",
"created_at": 1653798303000,
"last_updated_at": 1653798303000
}
Create an appointment type
Creates a new appointment type.
Required attributes
- Name
name- Type
- string
- Description
Name of the appointment type.
- Name
duration- Type
- number
- Description
Duration of the appointment type.
- Name
group- Type
- boolean
- Description
Whether this is a group appointment.
- Name
max_participants- Type
- number
- Description
Only applies if this is a group appointment. Max number of participants allowed in appointments of this appointment type.
- Name
charge_while_booking- Type
- object
- Description
- Amount to charge the patient when they are booking the appointment
- Name
charge_after_appointment- Type
- object
- Description
- Amount to charge the patient once the appointment is successfully completed
- Name
settings- Type
- object
- Description
- Settings for the appointment type.
- Name
created_by- Type
- string
- Description
Creator of the appointment type.
Optional attributes
- Name
description- Type
- string
- Description
Description of the appointment type.
Response
{
"id": "aptp_3XxtAULYUrX7GVsTKePy",
"object": "appointment_type",
"name": "Annual Check-in",
"description": "Annual check-in appointment for all patients",
"duration": 30,
"group": false,
"charge_while_booking": {
"enabled": true,
"auto_charge_if_possible": true,
"product": "prod_3XxtAULYUrX7GVsTKePy",
},
"charge_after_appointment": {
"enabled": false
},
"settings": {
"bookable_by_patient": true,
"required_buffer": 30,
"specific_license_types_required": true,
"license_types_required": ["MD"],
"care_team_required": false,
},
"created_by": "user_xeDpGyt67wTor93qKtS7",
"created_at": 1653798303000,
"last_updated_at": 1653798303000
}
Retrieve an appointment type
Retrieves the specified appointment type.
Response
{
"id": "aptp_3XxtAULYUrX7GVsTKePy",
"object": "appointment_type",
"name": "Annual Check-in",
"description": "Annual check-in appointment for all patients",
"duration": 30,
"group": false,
"charge_while_booking": {
"enabled": true,
"auto_charge_if_possible": true,
"product": "prod_3XxtAULYUrX7GVsTKePy",
},
"charge_after_appointment": {
"enabled": false
},
"settings": {
"bookable_by_patient": true,
"required_buffer": 30,
"specific_license_types_required": true,
"license_types_required": ["MD"],
"care_team_required": false,
},
"created_by": "user_xeDpGyt67wTor93qKtS7",
"created_at": 1653798303000,
"last_updated_at": 1653798303000
}
Update an appointment type
Updates the specified appointment type object by setting the values of the parameters passed. Any other parameters not provided will not be modified. Can only update appointment types that are not associated with any appointments.
Required attributes
- Name
updated_by- Type
- string
- Description
Updates to the appointment type made by.
Optional attributes
- Name
name- Type
- string
- Description
Name of the appointment type.
- Name
description- Type
- string
- Description
Description of the appointment type.
- Name
duration- Type
- number
- Description
Duration of the appointment type.
- Name
group- Type
- boolean
- Description
Whether this is a group appointment.
- Name
max_participants- Type
- number
- Description
Only applies if this is a group appointment. Max number of participants allowed in appointments of this appointment type.
- Name
charge_while_booking- Type
- object
- Description
- Amount to charge the patient when they are booking the appointment
- Name
charge_after_appointment- Type
- object
- Description
- Amount to charge the patient once the appointment is successfully completed
- Name
settings- Type
- object
- Description
- Settings for the appointment type.
Response
{
"id": "aptp_3XxtAULYUrX7GVsTKePy",
"object": "appointment_type",
"name": "Annual Check-in",
"description": "Annual check-in appointment for all patients",
"duration": 30,
"group": false,
"charge_while_booking": {
"enabled": true,
"auto_charge_if_possible": true,
"product": "prod_3XxtAULYUrX7GVsTKePy",
},
"charge_after_appointment": {
"enabled": false
},
"settings": {
"bookable_by_patient": true,
"required_buffer": 30,
"specific_license_types_required": true,
"license_types_required": ["MD"],
"care_team_required": false,
},
"created_by": "user_xeDpGyt67wTor93qKtS7",
"created_at": 1653798303000,
"last_updated_at": 1653798303000
}
List all appointment types
Returns a list of all appointment types.
Response
{
"object": "list",
"data": [
{
"id": "aptp_3XxtAULYUrX7GVsTKePy",
"object": "appointment_type",
"name": "Annual Check-in",
"description": "Annual check-in appointment for all patients",
"duration": 30,
"group": false,
"charge_while_booking": {
"enabled": true,
"auto_charge_if_possible": true,
"product": "prod_3XxtAULYUrX7GVsTKePy",
},
"charge_after_appointment": {
"enabled": false
},
"settings": {
"bookable_by_patient": true,
"required_buffer": 30,
"specific_license_types_required": true,
"license_types_required": ["MD"],
"care_team_required": false,
},
"created_by": "user_xeDpGyt67wTor93qKtS7",
"created_at": 1653798303000,
"last_updated_at": 1653798303000
},
]
}
Delete an appointment type
Deletes the specified appointment type. Appointment type cannot be deleted if it is associated with any appointments.
Required attributes
Optional attributes
Response
{
"id": "aptp_2UxtAULYUrX7GVsTKePy",
"object": "appointment_type",
"delete": true
}