Sign in

v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB
Group Appointment

Create group appointment

post/group_appointments

Request body

appointment_type_idstring int64

appointment type id

business_idstring int64

business id

ends_atstring date-time

If not provided on create or set to null on update, this will be based on the duration of the appointment type.

max_attendeesinteger

If not provided on create, this will be based on the max_attendees of the appointment type.

notesstring nullable
practitioner_idstring int64

practitioner id

starts_atstring date-time

Example request

{
  "appointment_type_id": "1",
  "business_id": "1",
  "practitioner_id": "1"
}

Response

Resource was created

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