v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB

Patient Case

List active patient cases

get/patient_cases/active

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
archived_at	date-time
closed_at	date-time
created_at	date-time
expiry_date	date
id	int64
issue_date	date
name	string
patient_id	int64
referral_type	string
updated_at	date-time

Response

successful operation

total_entriesinteger

Example response

{
  "patient_cases": [
    {
      "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"
        }
      }
    }
  ],
  "total_entries": 1,
  "links": {
    "self": "https://api.au1.cliniko.com/v1/patient_cases/active?page=2",
    "previous": "https://api.au1.cliniko.com/v1/patient_cases/active?page=1",
    "next": "https://api.au1.cliniko.com/v1/patient_cases/active?page=3"
  }
}