v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB

Group Appointment

Get group appointment

get/group_appointments/{id}

Path parameters

idstring int64 required

Query parameters

q[]string[]

Filter result by one or more fields.

See Filtering Results

Available filters:

Value	Format
archived_at	date-time
deleted_at	date-time

Response

Successful operation

archived_atstring date-time nullable

created_atstring date-time

deleted_atstring date-time nullable

ends_atstring date-time

idstring int64

max_attendeesinteger

notesstring nullable

patient_idsstring[] nullable

starts_atstring date-time

telehealth_urlstring uri nullable

updated_atstring date-time

Example response

{
  "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"
    }
  }
}