idstring required
The unique identifier for the user.
phoneNumberstring nullable
emailstring nullable
The user's email address.
type'PROVIDER' | 'PATIENT' | 'ASSISTANT' required
locationIdstring nullable
The location of the user.
externalIdstring nullable
The user's external identifier if available.
addressstring nullable
The user's primary address.
addressLineTwostring nullable
Additional address information.
citystring nullable
The city of the user's address.
statestring nullable
The state of the user's address.
zipCodestring nullable
The postal code of the user's address.
countrystring nullable
The country of the user's address.
createdDatestring date-time required
The date and time when the user was created.
addressValidboolean nullable
Whether the user's address is valid.
metaobject nullable
Any additional metadata about the user relevant to your system.
isArchivedboolean nullable
Whether the user is archived.
primaryLocationIdstring nullable
The primary location of the user.
genderstring nullable
The gender of the patient.
dateOfBirthstring date nullable
The date of birth of the patient.
patientMedicationsstring[] nullable
List of patient's self-reported medications.
onSchedulingBlacklistboolean nullable
Whether the patient is on the scheduling blacklist.
surchargeDisabledboolean nullable
Whether surcharges are disabled for this patient.
creditBalanceinteger nullable
Patient's credit balance in cents.
preferredProviderIdstring nullable
The preferred provider ID for this patient.
goalWeightnumber nullable
The goal weight of the patient.
optedOutOfSmsboolean nullable
Whether patient has opted out of SMS
appointmentCountinteger nullable
Total number of appointments for this patient
totalSpentinteger nullable
Total amount spent by this patient in cents
healthDataobject nullable
Dynamic health fields and values
profilePictureUrlstring nullable
URL to the patient's profile picture.