Business

Businesses represent a business or location (e.g. a clinic). Each Cliniko account can have unlimited businesses.

These are typically used for each physical location if there is more than one. Most Cliniko accounts have just one business.

Business

additional_information
string or null <= 5000 characters
additional_invoice_information
string or null <= 5000 characters
address_1
string or null
address_2
string or null
appointment_reminders_enabled
boolean or null
appointment_type_ids
Array of strings or null <int64>
object
archived_at
string or null <date-time>
business_name
string or null
business_registration_name
string or null
business_registration_value
string or null
city
string or null
contact_information
string or null
country
string or null
country_code
string or null

ISO 3166-1 country code

created_at
string <date-time>
deleted_at
string or null <date-time>
display_name
string or null
email_reply_to
string or null
id
string <int64>
label
string or null
object
post_code
string or null
object
show_in_online_bookings
boolean or null
state
string or null
time_zone
string or null

Human-readable label for a time zone. See link below for supported values.

Time zone Support through the API
time_zone_identifier
string or null

IANA identifier for a time zone. See link below for supported values.

Time zone Support through the API
updated_at
string <date-time>
website_address
string or null
{
  • "additional_information": "string",
  • "additional_invoice_information": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "appointment_reminders_enabled": true,
  • "appointment_type_ids": [
    • "1"
    ],
  • "appointments": {},
  • "archived_at": "2019-08-24T14:15:22Z",
  • "business_name": "string",
  • "business_registration_name": "string",
  • "business_registration_value": "string",
  • "city": "string",
  • "contact_information": "string",
  • "country": "string",
  • "country_code": "AU",
  • "created_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "display_name": "string",
  • "email_reply_to": "string",
  • "id": "1",
  • "label": "string",
  • "links": {},
  • "post_code": "string",
  • "practitioners": {},
  • "show_in_online_bookings": true,
  • "state": "string",
  • "time_zone": "Melbourne",
  • "time_zone_identifier": "Australia/Melbourne",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "website_address": "string"
}

List businesses

get/businesses
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
id int64
archived_at date-time
created_at date-time
deleted_at date-time
updated_at date-time
appointment_type_ids array
show_in_online_bookings boolean
sort
Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc
Responses
200

successful operation

Request samples 
Response samples 
application/json
{}
Create business
post/businesses
SecuritybasicAuth 
Request 
Request Body schema: application/json
additional_information
string or null  <= 5000 characters 
 
additional_invoice_information
string or null  <= 5000 characters 
 
address_1
string or null
 
address_2
string or null
 
appointment_reminders_enabled
boolean or null
 
appointment_type_ids
Array of strings or null <int64> 
 
business_name
string or null
 
business_registration_name
string or null
 
business_registration_value
string or null
 
city
string or null
 
contact_information
string or null
 
country_code
string or null
ISO 3166-1 country code


 
display_name
string or null
 
email_reply_to
string or null
 
logo
string
Base64 encoded file attachment


 
logo_height
integer
 
post_code
string or null
 
remove_logo
boolean
 
show_in_online_bookings
boolean or null
 
state
string or null
 
time_zone
string or null
 
time_zone_identifier
website_address
string or null
 
Responses 
201
Resource was created


422
Resource could not be saved due to validation errors


Request samples 
application/json
{
  • "additional_information": "string",
  • "additional_invoice_information": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "appointment_reminders_enabled": true,
  • "business_name": "string",
  • "business_registration_name": "string",
  • "business_registration_value": "string",
  • "city": "string",
  • "contact_information": "string",
  • "country_code": "AU",
  • "display_name": "string",
  • "email_reply_to": "string",
  • "logo": "string",
  • "logo_height": 0,
  • "post_code": "string",
  • "remove_logo": true,
  • "show_in_online_bookings": true,
  • "state": "string",
  • "time_zone": "Melbourne",
  • "time_zone_identifier": "Australia/Melbourne",
  • "website_address": "string",
  • "appointment_type_ids": [
    • "1"
    ]
}
Response samples 
application/json
{
  • "additional_information": "string",
  • "additional_invoice_information": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "appointment_reminders_enabled": true,
  • "appointment_type_ids": [
    • "1"
    ],
  • "appointments": {},
  • "archived_at": "2019-08-24T14:15:22Z",
  • "business_name": "string",
  • "business_registration_name": "string",
  • "business_registration_value": "string",
  • "city": "string",
  • "contact_information": "string",
  • "country": "string",
  • "country_code": "AU",
  • "created_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "display_name": "string",
  • "email_reply_to": "string",
  • "id": "1",
  • "label": "string",
  • "links": {},
  • "post_code": "string",
  • "practitioners": {},
  • "show_in_online_bookings": true,
  • "state": "string",
  • "time_zone": "Melbourne",
  • "time_zone_identifier": "Australia/Melbourne",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "website_address": "string"
}
Get business
get/businesses/{id}
SecuritybasicAuth 
Request 
path Parameters
id
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




deleted_at
date-time





 
Responses 
200
Successful operation


Request samples 
Response samples 
application/json
{
  • "additional_information": "string",
  • "additional_invoice_information": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "appointment_reminders_enabled": true,
  • "appointment_type_ids": [
    • "1"
    ],
  • "appointments": {},
  • "archived_at": "2019-08-24T14:15:22Z",
  • "business_name": "string",
  • "business_registration_name": "string",
  • "business_registration_value": "string",
  • "city": "string",
  • "contact_information": "string",
  • "country": "string",
  • "country_code": "AU",
  • "created_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "display_name": "string",
  • "email_reply_to": "string",
  • "id": "1",
  • "label": "string",
  • "links": {},
  • "post_code": "string",
  • "practitioners": {},
  • "show_in_online_bookings": true,
  • "state": "string",
  • "time_zone": "Melbourne",
  • "time_zone_identifier": "Australia/Melbourne",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "website_address": "string"
}
Update business
patch/businesses/{id}
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Request Body schema: application/json
additional_information
string or null  <= 5000 characters 
 
additional_invoice_information
string or null  <= 5000 characters 
 
address_1
string or null
 
address_2
string or null
 
appointment_reminders_enabled
boolean or null
 
appointment_type_ids
Array of strings or null <int64> 
 
business_name
string or null
 
business_registration_name
string or null
 
business_registration_value
string or null
 
city
string or null
 
contact_information
string or null
 
country_code
string or null
ISO 3166-1 country code


 
display_name
string or null
 
email_reply_to
string or null
 
logo
string
Base64 encoded file attachment


 
logo_height
integer
 
post_code
string or null
 
remove_logo
boolean
 
show_in_online_bookings
boolean or null
 
state
string or null
 
time_zone
string or null
 
time_zone_identifier
website_address
string or null
 
Responses 
200
Resource was updated


422
Resource could not be saved due to validation errors


Request samples 
application/json
{
  • "additional_information": "string",
  • "additional_invoice_information": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "appointment_reminders_enabled": true,
  • "business_name": "string",
  • "business_registration_name": "string",
  • "business_registration_value": "string",
  • "city": "string",
  • "contact_information": "string",
  • "country_code": "AU",
  • "display_name": "string",
  • "email_reply_to": "string",
  • "logo": "string",
  • "logo_height": 0,
  • "post_code": "string",
  • "remove_logo": true,
  • "show_in_online_bookings": true,
  • "state": "string",
  • "time_zone": "Melbourne",
  • "time_zone_identifier": "Australia/Melbourne",
  • "website_address": "string",
  • "appointment_type_ids": [
    • "1"
    ]
}
Response samples 
application/json
{
  • "additional_information": "string",
  • "additional_invoice_information": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "appointment_reminders_enabled": true,
  • "appointment_type_ids": [
    • "1"
    ],
  • "appointments": {},
  • "archived_at": "2019-08-24T14:15:22Z",
  • "business_name": "string",
  • "business_registration_name": "string",
  • "business_registration_value": "string",
  • "city": "string",
  • "contact_information": "string",
  • "country": "string",
  • "country_code": "AU",
  • "created_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "display_name": "string",
  • "email_reply_to": "string",
  • "id": "1",
  • "label": "string",
  • "links": {},
  • "post_code": "string",
  • "practitioners": {},
  • "show_in_online_bookings": true,
  • "state": "string",
  • "time_zone": "Melbourne",
  • "time_zone_identifier": "Australia/Melbourne",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "website_address": "string"
}
Archive businessDeprecated
delete/businesses/{id}
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Responses 
204
Resource was archived successfully


Request samples 
Archive business
post/businesses/{id}/archive
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Responses 
204
Resource was archived


Request samples 
Unarchive business
post/businesses/{id}/unarchive
SecuritybasicAuth 
Request 
path Parameters
id
required
string <int64> 
 
Responses 
200
Resource was unarchived


Request samples 
Response samples 
application/json
{
  • "additional_information": "string",
  • "additional_invoice_information": "string",
  • "address_1": "string",
  • "address_2": "string",
  • "appointment_reminders_enabled": true,
  • "appointment_type_ids": [
    • "1"
    ],
  • "appointments": {},
  • "archived_at": "2019-08-24T14:15:22Z",
  • "business_name": "string",
  • "business_registration_name": "string",
  • "business_registration_value": "string",
  • "city": "string",
  • "contact_information": "string",
  • "country": "string",
  • "country_code": "AU",
  • "created_at": "2019-08-24T14:15:22Z",
  • "deleted_at": "2019-08-24T14:15:22Z",
  • "display_name": "string",
  • "email_reply_to": "string",
  • "id": "1",
  • "label": "string",
  • "links": {},
  • "post_code": "string",
  • "practitioners": {},
  • "show_in_online_bookings": true,
  • "state": "string",
  • "time_zone": "Melbourne",
  • "time_zone_identifier": "Australia/Melbourne",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "website_address": "string"
}