Skip to main content
​
id
string

The client's unique identifier.

Example:

"cli_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
title
string | null

The client's honorific title.

Example:

"Ms"

​
first_name
string

The client's given name.

Example:

"Helen"

​
last_name
string

The client's family name.

Example:

"Keller"

​
preferred_name
string | null

The client's preferred name.

Example:

"Nell"

​
profession
string | null

The client's profession or occupation.

Example:

"Teacher"

​
email
string | null

The client's email address.

Example:

"helen.keller@example.com"

​
date_of_birth
string | null

The client's date of birth (ISO 8601).

Example:

"1987-06-27"

​
sex
string | null

The client's sex assigned at birth.

Example:

"female"

​
gender_identity
string | null

The client's gender identity.

Example:

"Woman"

​
pronouns
string | null

The client's pronouns.

Example:

"she/her"

​
privacy_policy_consent
enum<string> | null

The client's privacy policy consent status.

Available options:
accepted,
rejected
Example:

"accepted"

​
medications
object[] | null

The client's medications.

​
allergies
object[] | null

The client's allergies.

​
intolerances
string[] | null

The client's intolerances.

Example:
​
emergency_contact_id
string | null

The contact identifier for the emergency contact.

Example:

"con_01HQFQ9QWTNNPY58FZ8CB3FWWK"

​
emergency_contact_relationship
string | null

The client's relationship to the emergency contact.

Example:

"Guardian"

​
notes
string | null

The client's practitioner or admin notes.

Example:

"Client prefers morning appointments."

​
alert
string | null

The client's alert message for staff.

Example:

"Requires wheelchair access."

​
referral_type_id
string | null

The client's referral type identifier.

Example:

"ret_01J11QXSM53YENWF114C0MWGDJ"

​
referral_description
string | null

The client's referral description.

Example:

"Referred by GP at City Clinic."

​
referred_by_id
string | null

The client's referring entity identifier.

Example:

"cli_01HQQZCM1VDNHXDFEHX4X4KK52"

​
phone_number
string | null

The client's primary phone number.

Example:

"+61400123456"

​
phone_numbers
object[]

A list of the client's additional phone numbers.

Example:
​
address
object | null

The client's address details.

Example:
​
tag_ids
string[]

The IDs of tags attached to the client.

Example:
​
created_at
string

The timestamp when the client was created (ISO 8601).

Example:

"2024-01-01T12:00:00Z"