v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB

Attendee

List attendees for group appointment

get/group_appointments/{group_appointment_id}/attendees

Path parameters

group_appointment_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
appointment_id	int64
archived_at	date-time
booking_id	int64
cancelled_at	date-time
created_at	date-time
deleted_at	date-time
id	int64
invoice_status	integer
patient_case_id	int64
patient_id	int64
treatment_note_status	integer
updated_at	date-time

Response

successful operation

total_entriesinteger

Example response

{
  "attendees": [
    {
      "booking": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/bookings/1"
        }
      },
      "booking_ip_address": "10.0.0.43",
      "invoices": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/attendees/1/invoices"
        }
      },
      "links": {
        "self": "https://api.au1.cliniko.com/v1/attendees/1"
      },
      "patient": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/patients/1"
        }
      },
      "patient_case": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/patient_cases/1"
        }
      },
      "patient_forms": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/attendees/1/patient_forms"
        }
      },
      "treatment_notes": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/treatment_notes?q%5B%5D=attendee_id%3A%3D1"
        }
      }
    }
  ],
  "total_entries": 1,
  "links": {
    "self": "https://api.au1.cliniko.com/v1/group_appointments/1/attendees?page=2",
    "previous": "https://api.au1.cliniko.com/v1/group_appointments/1/attendees?page=1",
    "next": "https://api.au1.cliniko.com/v1/group_appointments/1/attendees?page=3"
  }
}