v2

latestOpenAPI 3.0.32026-08-07222102695.9 KB

Patient

List patients

get/patients

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
accepted_privacy_policy	boolean
archived_at	date-time
created_at	date-time
date_of_birth	date
email	string
first_name	string
id	int64
last_name	string
old_reference_id	string
preferred_first_name	string
updated_at	date-time

Response

successful operation

total_entriesinteger

Example response

{
  "patients": [
    {
      "appointments": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/patients/1/appointments"
        }
      },
      "attendees": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/attendees?q%5B%5D=patient_id%3A%3D1"
        }
      },
      "concession_type": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/concession_types/1"
        }
      },
      "country_code": "AU",
      "custom_fields": {
        "sections": [
          {
            "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70",
            "fields": [
              {
                "token": "ef4c43ec-105d-489c-88cc-0f3c5f67dc70"
              }
            ]
          }
        ]
      },
      "follow_ups_communication_channels": [
        1,
        2
      ],
      "invoices": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/patients/1/invoices"
        }
      },
      "latest_booking": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/bookings/1"
        }
      },
      "links": {
        "self": "https://api.au1.cliniko.com/v1/patients/1"
      },
      "medical_alerts": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/patients/1/medical_alerts"
        }
      },
      "merged_with_patient": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/patients/1"
        }
      },
      "patient_attachments": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/patients/1/patient_attachments"
        }
      },
      "patient_phone_numbers": [
        {
          "normalized_number": "39012345678",
          "number": "0-123-456-78"
        }
      ],
      "referring_doctor": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/contacts/1"
        }
      },
      "relationships": {
        "links": {
          "self": "https://api.au1.cliniko.com/v1/relationships?q%5B%5D=patient_id%3A%3D1"
        }
      },
      "reminders_communication_channels": [
        1,
        2
      ],
      "time_zone": "Australia/Melbourne"
    }
  ],
  "total_entries": 1,
  "links": {
    "self": "https://api.au1.cliniko.com/v1/patients?page=2",
    "previous": "https://api.au1.cliniko.com/v1/patients?page=1",
    "next": "https://api.au1.cliniko.com/v1/patients?page=3"
  }
}