Practitioner

All practitioners have an associated user account. Not all users are practitioners (e.g. receptionists wouldn't be).

You can only create appointments for practitioners (not for users).

Practitioner

active	boolean or null
	object
	object
created_at	string <date-time>
	object
description	string or null
designation	string or null
display_name	string or null
first_name	string or null
id	string <int64>
	object
label	string or null
last_name	string or null
	object
	object
show_in_online_bookings	boolean or null
title	string or null
updated_at	string <date-time>
	object

{"active": true,
"appointment_types": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types?q%5B%5D=practitioner_id%3A%3D1"
}
},
"appointments": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/appointments"
}
},
"created_at": "2019-08-24T14:15:22Z",
"default_appointment_type": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
}
},
"description": "string",
"designation": "string",
"display_name": "string",
"first_name": "string",
"id": "string",
"invoices": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/invoices"
}
},
"label": "string",
"last_name": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
},
"practitioner_reference_numbers": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/practitioner_reference_numbers"
}
},
"show_in_online_bookings": true,
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": {"links": {"self": "https://api.au1.cliniko.com/v1/users/1"
}
}
}

List practitioners

get/practitioners

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
created_at	date-time
id	int64
show_in_online_bookings	boolean
updated_at	date-time
user_id	int64

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

{"practitioners": [{"active": true,
"appointment_types": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types?q%5B%5D=practitioner_id%3A%3D1"
}
},
"appointments": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/appointments"
}
},
"created_at": "2019-08-24T14:15:22Z",
"default_appointment_type": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
}
},
"description": "string",
"designation": "string",
"display_name": "string",
"first_name": "string",
"id": "string",
"invoices": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/invoices"
}
},
"label": "string",
"last_name": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
},
"practitioner_reference_numbers": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/practitioner_reference_numbers"
}
},
"show_in_online_bookings": true,
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": {"links": {"self": "https://api.au1.cliniko.com/v1/users/1"
}
}
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/practitioners?page=2",
"previous": "https://api.au1.cliniko.com/v1/practitioners?page=1",
"next": "https://api.au1.cliniko.com/v1/practitioners?page=3"
}
}

List inactive practitioners

get/practitioners/inactive

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
created_at	date-time
id	int64
show_in_online_bookings	boolean
updated_at	date-time
user_id	int64

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

{"practitioners": [{"active": true,
"appointment_types": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types?q%5B%5D=practitioner_id%3A%3D1"
}
},
"appointments": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/appointments"
}
},
"created_at": "2019-08-24T14:15:22Z",
"default_appointment_type": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
}
},
"description": "string",
"designation": "string",
"display_name": "string",
"first_name": "string",
"id": "string",
"invoices": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/invoices"
}
},
"label": "string",
"last_name": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
},
"practitioner_reference_numbers": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/practitioner_reference_numbers"
}
},
"show_in_online_bookings": true,
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": {"links": {"self": "https://api.au1.cliniko.com/v1/users/1"
}
}
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/inactive?page=2",
"previous": "https://api.au1.cliniko.com/v1/practitioners/inactive?page=1",
"next": "https://api.au1.cliniko.com/v1/practitioners/inactive?page=3"
}
}

Get practitioner

get/practitioners/{id}

SecuritybasicAuth

Request

path Parameters

required

string <int64>

Responses

200

Successful operation

Request samples

curl
JavaScript
Python
Ruby

Response samples

application/json

{"active": true,
"appointment_types": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types?q%5B%5D=practitioner_id%3A%3D1"
}
},
"appointments": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/appointments"
}
},
"created_at": "2019-08-24T14:15:22Z",
"default_appointment_type": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
}
},
"description": "string",
"designation": "string",
"display_name": "string",
"first_name": "string",
"id": "string",
"invoices": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/invoices"
}
},
"label": "string",
"last_name": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
},
"practitioner_reference_numbers": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/practitioner_reference_numbers"
}
},
"show_in_online_bookings": true,
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": {"links": {"self": "https://api.au1.cliniko.com/v1/users/1"
}
}
}

List practitioners for appointment type

get/appointment_types/{appointment_type_id}/practitioners

SecuritybasicAuth

Request

path Parameters

appointment_type_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
created_at	date-time
id	int64
show_in_online_bookings	boolean
updated_at	date-time
user_id	int64

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

{"practitioners": [{"active": true,
"appointment_types": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types?q%5B%5D=practitioner_id%3A%3D1"
}
},
"appointments": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/appointments"
}
},
"created_at": "2019-08-24T14:15:22Z",
"default_appointment_type": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
}
},
"description": "string",
"designation": "string",
"display_name": "string",
"first_name": "string",
"id": "string",
"invoices": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/invoices"
}
},
"label": "string",
"last_name": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
},
"practitioner_reference_numbers": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/practitioner_reference_numbers"
}
},
"show_in_online_bookings": true,
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": {"links": {"self": "https://api.au1.cliniko.com/v1/users/1"
}
}
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1/practitioners?page=2",
"previous": "https://api.au1.cliniko.com/v1/appointment_types/1/practitioners?page=1",
"next": "https://api.au1.cliniko.com/v1/appointment_types/1/practitioners?page=3"
}
}

List practitioners for business

get/businesses/{business_id}/practitioners

SecuritybasicAuth

Request

path Parameters

business_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
created_at	date-time
id	int64
show_in_online_bookings	boolean
updated_at	date-time
user_id	int64

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

{"practitioners": [{"active": true,
"appointment_types": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types?q%5B%5D=practitioner_id%3A%3D1"
}
},
"appointments": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/appointments"
}
},
"created_at": "2019-08-24T14:15:22Z",
"default_appointment_type": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
}
},
"description": "string",
"designation": "string",
"display_name": "string",
"first_name": "string",
"id": "string",
"invoices": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/invoices"
}
},
"label": "string",
"last_name": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
},
"practitioner_reference_numbers": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/practitioner_reference_numbers"
}
},
"show_in_online_bookings": true,
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": {"links": {"self": "https://api.au1.cliniko.com/v1/users/1"
}
}
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1/practitioners?page=2",
"previous": "https://api.au1.cliniko.com/v1/businesses/1/practitioners?page=1",
"next": "https://api.au1.cliniko.com/v1/businesses/1/practitioners?page=3"
}
}

List inactive practitioners for appointment type

get/appointment_types/{appointment_type_id}/practitioners/inactive

SecuritybasicAuth

Request

path Parameters

appointment_type_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
created_at	date-time
id	int64
show_in_online_bookings	boolean
updated_at	date-time
user_id	int64

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

{"practitioners": [{"active": true,
"appointment_types": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types?q%5B%5D=practitioner_id%3A%3D1"
}
},
"appointments": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/appointments"
}
},
"created_at": "2019-08-24T14:15:22Z",
"default_appointment_type": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
}
},
"description": "string",
"designation": "string",
"display_name": "string",
"first_name": "string",
"id": "string",
"invoices": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/invoices"
}
},
"label": "string",
"last_name": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
},
"practitioner_reference_numbers": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/practitioner_reference_numbers"
}
},
"show_in_online_bookings": true,
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": {"links": {"self": "https://api.au1.cliniko.com/v1/users/1"
}
}
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1/practitioners/inactive?page=2",
"previous": "https://api.au1.cliniko.com/v1/appointment_types/1/practitioners/inactive?page=1",
"next": "https://api.au1.cliniko.com/v1/appointment_types/1/practitioners/inactive?page=3"
}
}

List inactive practitioners for business

get/businesses/{business_id}/practitioners/inactive

SecuritybasicAuth

Request

path Parameters

business_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
created_at	date-time
id	int64
show_in_online_bookings	boolean
updated_at	date-time
user_id	int64

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

{"practitioners": [{"active": true,
"appointment_types": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types?q%5B%5D=practitioner_id%3A%3D1"
}
},
"appointments": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/appointments"
}
},
"created_at": "2019-08-24T14:15:22Z",
"default_appointment_type": {"links": {"self": "https://api.au1.cliniko.com/v1/appointment_types/1"
}
},
"description": "string",
"designation": "string",
"display_name": "string",
"first_name": "string",
"id": "string",
"invoices": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/invoices"
}
},
"label": "string",
"last_name": "string",
"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1"
},
"practitioner_reference_numbers": {"links": {"self": "https://api.au1.cliniko.com/v1/practitioners/1/practitioner_reference_numbers"
}
},
"show_in_online_bookings": true,
"title": "string",
"updated_at": "2019-08-24T14:15:22Z",
"user": {"links": {"self": "https://api.au1.cliniko.com/v1/users/1"
}
}
}
],
"total_entries": 1,
"links": {"self": "https://api.au1.cliniko.com/v1/businesses/1/practitioners/inactive?page=2",
"previous": "https://api.au1.cliniko.com/v1/businesses/1/practitioners/inactive?page=1",
"next": "https://api.au1.cliniko.com/v1/businesses/1/practitioners/inactive?page=3"
}
}