v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB

Attendee

Get attendee

get/attendees/{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
cancelled_at	date-time
deleted_at	date-time

Response

Successful operation

archived_atstring date-time nullable

arrivedboolean nullable

booking_ip_addressstring ipv4 nullable

cancellation_notestring nullable

cancellation_reasoninteger nullable

cancellation_urlstring uri nullable

cancelled_atstring date-time nullable

created_atstring date-time

deleted_atstring date-time nullable

email_reminder_sentboolean nullable

Please use the sent_email_reminders_count attribute instead.

idstring int64

invoice_status10 | 20 | 30 | 40 nullable

Enum Value	Description
10	Open
20	Paid
30	Closed
40	Open credit

notesstring nullable

online_booking_policy_acceptedboolean nullable

sent_email_follow_ups_countinteger nullable

sent_email_reminders_countinteger nullable

sent_sms_follow_ups_countinteger nullable

sent_sms_reminders_countinteger nullable

sms_reminder_sentboolean nullable

Please use the sent_sms_reminders_count attribute instead.

telehealth_urlstring uri nullable

treatment_note_status10 | 90 nullable

Enum Value	Description
10	Draft
90	Final

updated_atstring date-time

Example response

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