Sign in

v1

latestOpenAPI 3.1.0Private2026-07-24196240439.2 KB
Patient

List All Patients

Note: Archived patients are excluded from responses by default. Use filter=archived to return only archived patients.

get/provider/patients

Query parameters

limitinteger

Allows limiting the number of patients returned.

offsetinteger

Allows offsetting the number of patients returned.

filter'archived'

Show only archived patients.

Response

Successful response

idstring
address_citystring
address_countrystring
address_line1string
address_line2string
address_statestring
address_zipstring
agestring
chosen_first_namestring
chosen_last_namestring
chosen_middle_namestring
chosen_suffixstring
chosen_titlestring
created_atstring date-time
dobstring date
electronic_communication_consent_acceptedstring
electronic_communication_consent_accepted_atstring
emailstring
engagedboolean
external_link_idstring
first_namestring
genderstring
gender_identitystring
gender_otherstring
health_insurance_group_idstring
health_insurance_member_idstring
health_insurance_payer_idstring
health_insurance_payer_namestring
hipaa_authorization_acceptedboolean
hipaa_authorization_accepted_atstring date-time
import_idstring
import_sourcestring
joined_practice_datestring date
last_engagement_datestring date
last_namestring
lead_source_otherstring
master_record_sponsorstring
membership_statusstring
middle_namestring
namestring
patient_agreement_acceptedboolean
patient_agreement_accepted_atstring date-time
preferred_languagestring
pronounsstring
provider_web_linkstring
sexstring
suffixstring
terms_acceptedboolean
terms_accepted_atstring date-time
updated_atstring date-time
uses_tobaccoboolean
All 196 operations