v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB

Group Appointment

List group appointments

get/group_appointments

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_id	int64
archived_at	date-time
business_id	int64
created_at	date-time
deleted_at	date-time
ends_at	date-time
id	int64
patient_ids	array
practitioner_id	int64
repeated_from_id	int64
starts_at	date-time
updated_at	date-time

Response

successful operation

total_entriesinteger

Example response

{
  "group_appointments": [
    {
      "appointment_type": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/appointment_types/1"
        }
      },
      "attendees": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/group_appointments/1/attendees"
        }
      },
      "business": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/businesses/1"
        }
      },
      "conflicts": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/group_appointments/1/conflicts"
        }
      },
      "links": {
        "self": "https://api.au1.cliniko.com/v1/group_appointments/1"
      },
      "patient_ids": [
        "1"
      ],
      "practitioner": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/practitioners/1"
        }
      },
      "repeated_from": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/group_appointments/1"
        }
      },
      "repeats": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/group_appointments?q[]=repeated_from_id:=1"
        }
      }
    }
  ],
  "total_entries": 1,
  "links": {
    "self": "https://api.au1.cliniko.com/v1/group_appointments?page=2",
    "previous": "https://api.au1.cliniko.com/v1/group_appointments?page=1",
    "next": "https://api.au1.cliniko.com/v1/group_appointments?page=3"
  }
}