Appointment Type

AppointmentType

add_deposit_to_account_credit	boolean or null
appointment_confirmation_template_ids	Array of strings or null <int64>
appointment_reminder_template_ids	Array of strings or null <int64>
	object
	object
archived_at	string or null <date-time>
	object Deprecated
category	string or null
color	string^#([A-Fa-f0-9]{6}\|[A-Fa-f0-9]{3})$
created_at	string <date-time>
deposit_price	string or null <decimal> [ 0 .. 4000000000 )
description	string or null
duration_in_minutes	integer ( 0 .. 1440 )
id	string <int64>
	object
max_attendees	integer ( 0 .. 100 )
name	string <= 255 characters
online_bookings_lead_time_hours	integer or null Enum: 0 1 2 4 12 18 24 48 72 168 336 504 672
online_payments_enabled	boolean or null
online_payments_mode	string or null Enum: "deposit_required" "optional" "required"
	object
	object Deprecated
show_in_online_bookings	boolean or null
telehealth_enabled	boolean or null
	object
updated_at	string <date-time>

{"add_deposit_to_account_credit": true,
"appointment_confirmation_template_ids": ["1"
],
"appointment_reminder_template_ids": ["1"
],
"appointment_type_billable_items": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_type_billable_items?q%5B%5D=appointment_type_id%3A%3D1"
}
},
"appointment_type_products": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_type_products?q%5B%5D=appointment_type_id%3A%3D1"
}
},
"archived_at": "2019-08-24T14:15:22Z",
"billable_item": {"links": {"self": "https://api.au1.cliniko.com/v1/billable_items/1"
}
},
"category": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"deposit_price": "string",
"description": "string",
"duration_in_minutes": 0,
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
},
"max_attendees": 0,
"name": "string",
"online_bookings_lead_time_hours": 0,
"online_payments_enabled": true,
"online_payments_mode": "deposit_required",
"practitioners": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners?q%5B%5D=appointment_type_id%3A%3D1"
}
},
"product": {"links": {"self": "https://api.au1.cliniko.com/v1/products/1"
}
},
"show_in_online_bookings": true,
"telehealth_enabled": true,
"treatment_note_template": {"links": {"self": "https://api.au1.cliniko.com/v1/treatment_note_templates/1"
}
},
"updated_at": "2019-08-24T14:15:22Z"
}

List appointment types

get/appointment_types

SecuritybasicAuth

Request

query Parameters

order

string

Deprecated

Enum: "asc" "desc"

page

integer

per_page

integer [ 1 .. 100 ]

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
appointment_confirmation_template_ids	array
appointment_reminder_template_ids	array
archived_at	date-time
category	string
created_at	date-time
id	int64
online_payments_mode	string
show_in_online_bookings	boolean
updated_at	date-time

sort

Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc

Responses

200

successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"appointment_types": [{"add_deposit_to_account_credit": true,
"appointment_confirmation_template_ids": ["1"
],
"appointment_reminder_template_ids": ["1"
],
"appointment_type_billable_items": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_type_billable_items?q%5B%5D=appointment_type_id%3A%3D1"
}
},
"appointment_type_products": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_type_products?q%5B%5D=appointment_type_id%3A%3D1"
}
},
"archived_at": "2019-08-24T14:15:22Z",
"billable_item": {"links": {"self": "https://api.au1.cliniko.com/v1/billable_items/1"
}
},
"category": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"deposit_price": "string",
"description": "string",
"duration_in_minutes": 0,
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
},
"max_attendees": 0,
"name": "string",
"online_bookings_lead_time_hours": 0,
"online_payments_enabled": true,
"online_payments_mode": "deposit_required",
"practitioners": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners?q%5B%5D=appointment_type_id%3A%3D1"
}
},
"product": {"links": {"self": "https://api.au1.cliniko.com/v1/products/1"
}
},
"show_in_online_bookings": true,
"telehealth_enabled": true,
"treatment_note_template": {"links": {"self": "https://api.au1.cliniko.com/v1/treatment_note_templates/1"
}
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types?page=2",
"previous": "https://api.au1.cliniko.com/v1/appointment_types?page=1",
"next": "https://api.au1.cliniko.com/v1/appointment_types?page=3"
}
}

Create appointment type

post/appointment_types

SecuritybasicAuth

Request

Request Body schema: application/json

add_deposit_to_account_credit	boolean or null
appointment_confirmation_template_ids	Array of strings or null <int64>
appointment_reminder_template_ids	Array of strings or null <int64>
billable_item_id	string <int64> Deprecated billable item id
business_ids	Array of strings <int64>
category	string or null
color	string^#([A-Fa-f0-9]{6}\|[A-Fa-f0-9]{3})$
deposit_price	string or null <decimal> [ 0 .. 4000000000 )
description	string or null
duration_in_minutes	integer ( 0 .. 1440 )
max_attendees	integer ( 0 .. 100 )
name	string <= 255 characters
online_bookings_lead_time_hours	integer or null Enum: 0 1 2 4 12 18 24 48 72 168 336 504 672
online_payments_mode	string or null Enum: "deposit_required" "optional" "required"
practitioner_ids	Array of strings <int64> Practitioner ids
product_id	string <int64> Deprecated product id
show_in_online_bookings	boolean or null
telehealth_enabled	boolean or null
treatment_note_template_id	string <int64> treatment note template id

Responses

201

Resource was created

422

Resource could not be saved due to validation errors

Request samples

Payload
curl
JavaScript
Python
Ruby

application/json

{"add_deposit_to_account_credit": true,
"billable_item_id": "1",
"category": "string",
"color": "string",
"deposit_price": "string",
"description": "string",
"duration_in_minutes": 0,
"online_bookings_lead_time_hours": 0,
"online_payments_mode": "deposit_required",
"max_attendees": 0,
"name": "string",
"product_id": "1",
"show_in_online_bookings": true,
"telehealth_enabled": true,
"treatment_note_template_id": "1",
"appointment_confirmation_template_ids": ["1"
],
"appointment_reminder_template_ids": ["1"
],
"business_ids": ["1"
],
"practitioner_ids": ["1"
]
}

Response samples

application/json

{"add_deposit_to_account_credit": true,
"appointment_confirmation_template_ids": ["1"
],
"appointment_reminder_template_ids": ["1"
],
"appointment_type_billable_items": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_type_billable_items?q%5B%5D=appointment_type_id%3A%3D1"
}
},
"appointment_type_products": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_type_products?q%5B%5D=appointment_type_id%3A%3D1"
}
},
"archived_at": "2019-08-24T14:15:22Z",
"billable_item": {"links": {"self": "https://api.au1.cliniko.com/v1/billable_items/1"
}
},
"category": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"deposit_price": "string",
"description": "string",
"duration_in_minutes": 0,
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
},
"max_attendees": 0,
"name": "string",
"online_bookings_lead_time_hours": 0,
"online_payments_enabled": true,
"online_payments_mode": "deposit_required",
"practitioners": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners?q%5B%5D=appointment_type_id%3A%3D1"
}
},
"product": {"links": {"self": "https://api.au1.cliniko.com/v1/products/1"
}
},
"show_in_online_bookings": true,
"telehealth_enabled": true,
"treatment_note_template": {"links": {"self": "https://api.au1.cliniko.com/v1/treatment_note_templates/1"
}
},
"updated_at": "2019-08-24T14:15:22Z"
}

Get appointment type

get/appointment_types/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

query Parameters

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
archived_at	date-time

Responses

200

Successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"add_deposit_to_account_credit": true,
"appointment_confirmation_template_ids": ["1"
],
"appointment_reminder_template_ids": ["1"
],
"appointment_type_billable_items": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_type_billable_items?q%5B%5D=appointment_type_id%3A%3D1"
}
},
"appointment_type_products": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_type_products?q%5B%5D=appointment_type_id%3A%3D1"
}
},
"archived_at": "2019-08-24T14:15:22Z",
"billable_item": {"links": {"self": "https://api.au1.cliniko.com/v1/billable_items/1"
}
},
"category": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"deposit_price": "string",
"description": "string",
"duration_in_minutes": 0,
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
},
"max_attendees": 0,
"name": "string",
"online_bookings_lead_time_hours": 0,
"online_payments_enabled": true,
"online_payments_mode": "deposit_required",
"practitioners": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners?q%5B%5D=appointment_type_id%3A%3D1"
}
},
"product": {"links": {"self": "https://api.au1.cliniko.com/v1/products/1"
}
},
"show_in_online_bookings": true,
"telehealth_enabled": true,
"treatment_note_template": {"links": {"self": "https://api.au1.cliniko.com/v1/treatment_note_templates/1"
}
},
"updated_at": "2019-08-24T14:15:22Z"
}

Update appointment type

patch/appointment_types/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Request Body schema: application/json

add_deposit_to_account_credit	boolean or null
appointment_confirmation_template_ids	Array of strings or null <int64>
appointment_reminder_template_ids	Array of strings or null <int64>
billable_item_id	string <int64> Deprecated billable item id
business_ids	Array of strings <int64>
category	string or null
color	string^#([A-Fa-f0-9]{6}\|[A-Fa-f0-9]{3})$
deposit_price	string or null <decimal> [ 0 .. 4000000000 )
description	string or null
duration_in_minutes	integer ( 0 .. 1440 )
max_attendees	integer ( 0 .. 100 )
name	string <= 255 characters
online_bookings_lead_time_hours	integer or null Enum: 0 1 2 4 12 18 24 48 72 168 336 504 672
online_payments_mode	string or null Enum: "deposit_required" "optional" "required"
practitioner_ids	Array of strings <int64> Practitioner ids
product_id	string <int64> Deprecated product id
show_in_online_bookings	boolean or null
telehealth_enabled	boolean or null
treatment_note_template_id	string <int64> treatment note template id

Responses

200

Resource was updated

422

Resource could not be saved due to validation errors

Request samples

Payload
curl
JavaScript
Python
Ruby

application/json

{"add_deposit_to_account_credit": true,
"billable_item_id": "1",
"category": "string",
"color": "string",
"deposit_price": "string",
"description": "string",
"duration_in_minutes": 0,
"online_bookings_lead_time_hours": 0,
"online_payments_mode": "deposit_required",
"max_attendees": 0,
"name": "string",
"product_id": "1",
"show_in_online_bookings": true,
"telehealth_enabled": true,
"treatment_note_template_id": "1",
"appointment_confirmation_template_ids": ["1"
],
"appointment_reminder_template_ids": ["1"
],
"business_ids": ["1"
],
"practitioner_ids": ["1"
]
}

Response samples

application/json

{"add_deposit_to_account_credit": true,
"appointment_confirmation_template_ids": ["1"
],
"appointment_reminder_template_ids": ["1"
],
"appointment_type_billable_items": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_type_billable_items?q%5B%5D=appointment_type_id%3A%3D1"
}
},
"appointment_type_products": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_type_products?q%5B%5D=appointment_type_id%3A%3D1"
}
},
"archived_at": "2019-08-24T14:15:22Z",
"billable_item": {"links": {"self": "https://api.au1.cliniko.com/v1/billable_items/1"
}
},
"category": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"deposit_price": "string",
"description": "string",
"duration_in_minutes": 0,
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
},
"max_attendees": 0,
"name": "string",
"online_bookings_lead_time_hours": 0,
"online_payments_enabled": true,
"online_payments_mode": "deposit_required",
"practitioners": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners?q%5B%5D=appointment_type_id%3A%3D1"
}
},
"product": {"links": {"self": "https://api.au1.cliniko.com/v1/products/1"
}
},
"show_in_online_bookings": true,
"telehealth_enabled": true,
"treatment_note_template": {"links": {"self": "https://api.au1.cliniko.com/v1/treatment_note_templates/1"
}
},
"updated_at": "2019-08-24T14:15:22Z"
}

Archive appointment typeDeprecated

delete/appointment_types/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Responses

204

Resource was archived successfully

Request samples

curl
JavaScript
Python
Ruby

Archive appointment type

post/appointment_types/{id}/archive

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Responses

204

Resource was archived

Request samples

curl
JavaScript
Python
Ruby

List appointment types for practitioner

get/practitioners/{practitioner_id}/appointment_types

SecuritybasicAuth

Request

path Parameters

practitioner_id

required

string <int64>

query Parameters

order

string

Deprecated

Enum: "asc" "desc"

page

integer

per_page

integer [ 1 .. 100 ]

q[]

Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
appointment_confirmation_template_ids	array
appointment_reminder_template_ids	array
archived_at	date-time
category	string
created_at	date-time
id	int64
online_payments_mode	string
show_in_online_bookings	boolean
updated_at	date-time

sort

Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc

Responses

200

successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"appointment_types": [{"add_deposit_to_account_credit": true,
"appointment_confirmation_template_ids": ["1"
],
"appointment_reminder_template_ids": ["1"
],
"appointment_type_billable_items": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_type_billable_items?q%5B%5D=appointment_type_id%3A%3D1"
}
},
"appointment_type_products": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_type_products?q%5B%5D=appointment_type_id%3A%3D1"
}
},
"archived_at": "2019-08-24T14:15:22Z",
"billable_item": {"links": {"self": "https://api.au1.cliniko.com/v1/billable_items/1"
}
},
"category": "string",
"color": "string",
"created_at": "2019-08-24T14:15:22Z",
"deposit_price": "string",
"description": "string",
"duration_in_minutes": 0,
"id": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
},
"max_attendees": 0,
"name": "string",
"online_bookings_lead_time_hours": 0,
"online_payments_enabled": true,
"online_payments_mode": "deposit_required",
"practitioners": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners?q%5B%5D=appointment_type_id%3A%3D1"
}
},
"product": {"links": {"self": "https://api.au1.cliniko.com/v1/products/1"
}
},
"show_in_online_bookings": true,
"telehealth_enabled": true,
"treatment_note_template": {"links": {"self": "https://api.au1.cliniko.com/v1/treatment_note_templates/1"
}
},
"updated_at": "2019-08-24T14:15:22Z"
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/appointment_types?page=2",
"previous": "https://api.au1.cliniko.com/v1/practitioners/1/appointment_types?page=1",
"next": "https://api.au1.cliniko.com/v1/practitioners/1/appointment_types?page=3"
}
}