The tenant you are making this request on behalf of
Your api key
The user's first name.
The user's last name.
An identifier in your system that corresponds to this patient.
The user's email address.
The user's phone number.
The user's primary address.
Additional address information.
The city of the user's address.
The state of the user's address.
The postal code of the user's address.
The country of the user's address.
Whether the user's address is valid.
Any additional metadata about the user relevant to your system.
The primary location of the patient.
The unique identifier for the user.
The user's Firebase UID if available.
The date of birth of the patient.
The gender of the patient.
The source of the patient.
SELF_SCHEDULING, CALL, TEXT, MANUALLY_CREATED, UPLOADED_FROM_FILE, FORM, SEED_DATA, DEMO, EXTERNAL_INTEGRATION, OTHER Whether the patient is on the scheduling blacklist.
Whether surcharges are disabled for this patient.
Patient's credit balance in cents.
The preferred provider ID for this patient.
Successful Response
The unique identifier for the user.
The type of user.
PROVIDER, PATIENT, ASSISTANT The date and time when the user was created.
The user's first name.
The user's last name.
The user's phone number.
The user's email address.
The location of the user.
The user's external identifier if available.
The user's primary address.
Additional address information.
The city of the user's address.
The state of the user's address.
The postal code of the user's address.
The country of the user's address.
Whether the user's address is valid.
Any additional metadata about the user relevant to your system.
Whether the user is archived.
The primary location of the user.
The gender of the patient.
The date of birth of the patient.
List of patient's self-reported medications.
Whether the patient is on the scheduling blacklist.
Whether surcharges are disabled for this patient.
List of patient tags
Patient's credit balance in cents.
The preferred provider ID for this patient.