v1

latestOpenAPI 3.1.02026-07-26364986.4 KB

Patients

Get a Patient

Retrieve detailed patient information using their unique identifier

get/api/2026-01-01/patients/{patient_id}

Path parameters

patient_idstring uuid required

The ID of the patient

Response

The patient

idstring uuid required

Unique identifier for the patient

first_namestring

Patient's first name

middle_namestring

Patient's middle name

last_namestring

Patient's last name

prefixstring

Patient's name prefix/title

preferred_namestring

Patient's preferred name or nickname

sex'male' | 'female' | 'x'

Patient's sex which matches what is on their insurance policies

genderstring

Patient's current gender, which may differ from gender indicated on their insurance policies

pronounsstring

Patient's preferred pronouns

date_of_birthstring date

Patient's date of birth. Format: YYYY-MM-DD

guardian_namestring

Patient's guardian name

patient_sincestring date

Patient's date of registration

patient_numberstring

Patient's number

emailstring email

Patient's email address

send_marketing_emailsboolean

Patient's marketing email preferences

do_not_emailboolean

Patient's general email opt-out preference

status'active' | 'discharged' | 'deceased' | 'archived'

Patient's current lifecycle state

mobile_country_codestring

Deprecated. Use the phone_numbers array instead. This field will be removed in a future version.

mobile_phone_numberstring

Deprecated. Use the phone_numbers array instead. This field will be removed in a future version.

street_addressstring

Patient's street address

street_address_2string

Additional street address information

citystring

Patient's city of residence

provincestring

Patient's state/province

postalstring

Postal/ZIP code

countrystring

Country code

Example response

{
  "deep_links": {
    "profile": {
      "web": "https://account.janeapp.com/admin#patients/0199173f-240f-7f6a-9bce-a9836f536f03"
    }
  }
}