v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB

Business

List businesses

get/businesses

Query parameters

pageinteger

per_pageinteger

sortstring[]

Comma separated search fields. See: Ordering

[
  "created_at:desc"
]

order'asc' | 'desc'

q[]string[]

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
appointment_type_ids	array
archived_at	date-time
created_at	date-time
id	int64
show_in_online_bookings	boolean
updated_at	date-time

Response

successful operation

total_entriesinteger

Example response

{
  "businesses": [
    {
      "appointment_type_ids": [
        "1"
      ],
      "appointments": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/businesses/1/appointments"
        }
      },
      "country_code": "AU",
      "links": {
        "self": "https://api.au1.cliniko.com/v1/businesses/1"
      },
      "practitioners": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/businesses/1/practitioners"
        }
      },
      "time_zone": "Melbourne",
      "time_zone_identifier": "Australia/Melbourne"
    }
  ],
  "total_entries": 1,
  "links": {
    "self": "https://api.au1.cliniko.com/v1/businesses?page=2",
    "previous": "https://api.au1.cliniko.com/v1/businesses?page=1",
    "next": "https://api.au1.cliniko.com/v1/businesses?page=3"
  }
}