v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB

Patient Case

Get patient case

get/patient_cases/{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

Response

Successful operation

archived_atstring date-time nullable

attendee_idsstring[] nullable

closedboolean nullable

closed_atstring date-time nullable

created_atstring date-time

expiry_datestring date nullable

idstring int64

include_cancelled_attendeesboolean nullable

include_dna_attendeesboolean nullable

issue_datestring date nullable

max_invoiceable_amountstring decimal nullable

max_sessionsinteger nullable

namestring

notesstring nullable

referralboolean nullable

referral_type'dva' | 'medicare' nullable

updated_atstring date-time

Example response

{
  "attendees": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patient_cases/1/attendees"
    }
  },
  "bookings": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patient_cases/1/bookings"
    }
  },
  "contact": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/contacts/1"
    }
  },
  "invoices": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patient_cases/1/invoices"
    }
  },
  "links": {
    "self": "https://api.au1.cliniko.com/v1/patient_cases/1"
  },
  "patient": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patients/1"
    }
  },
  "patient_attachments": {
    "links": {
      "self": "https://api.au1.cliniko.com/v1/patient_cases/1/patient_attachments"
    }
  }
}