v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB

Practitioner

List practitioners for business

get/businesses/{business_id}/practitioners

Path parameters

business_idstring int64 required

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

Response

successful operation

total_entriesinteger

Example response

{
  "practitioners": [
    {
      "appointment_types": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/practitioners/1/appointment_types"
        }
      },
      "appointments": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/practitioners/1/appointments"
        }
      },
      "default_appointment_type": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/appointment_types/1"
        }
      },
      "invoices": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/practitioners/1/invoices"
        }
      },
      "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"
        }
      },
      "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"
  }
}