v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB

Appointment Type

List appointment types

get/appointment_types

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_confirmation_template_ids	array
appointment_follow_up_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

Response

successful operation

total_entriesinteger

Example response

{
  "appointment_types": [
    {
      "appointment_confirmation_template_ids": [
        "1"
      ],
      "appointment_follow_up_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"
        }
      },
      "billable_item": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/billable_items/1"
        }
      },
      "links": {
        "self": "https://api.au1.cliniko.com/v1/appointment_types/1"
      },
      "practitioners": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/appointment_types/1/practitioners"
        }
      },
      "product": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/products/1"
        }
      },
      "treatment_note_template": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/treatment_note_templates/1"
        }
      }
    }
  ],
  "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"
  }
}