HIhint
Patient

List All Patients

Changed on

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

get/provider/patients

Request

  • Base URL
    https://api.sandbox.hint.com/api
  • URL
    https://api.sandbox.hint.com/api/provider/patients
  • Auth
    API key in header AUTHORIZATION

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
autopayboolean

Whether the patient is on autopay. When true, Hint automatically schedules and collects payment for membership invoices billed to this patient. For a dependent, the paying account holder's autopay governs their invoices. Hint does not check this setting when you process a payment through the API.

chosen_first_namestring
chosen_last_namestring
chosen_middle_namestring
chosen_suffixstring
chosen_titlestring
created_atstring date-time
customer_typestring
dobstring date
electronic_communication_consent_acceptedstring
electronic_communication_consent_accepted_atstring
emailstring
email_marketing_authorization'opted_in' | 'opted_out'

Marketing consent recorded for this record's email address: opted_in (explicit opt-in), opted_out (explicit opt-out), or null when none has been recorded. null is not an opt-out — marketing email is permitted unless opted_out. Set it with Set Communication Authorization; it is read-only here.

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

Deprecated. Whether the current version of the practice's migrated legacy patient contract was accepted. This does not reflect acceptance of other patient documents. Returns false if no legacy contract exists.

patient_agreement_accepted_atstring date-time

Deprecated. When the current version of the migrated legacy patient contract was accepted. This does not reflect acceptance of other patient documents.

preferred_languagestring
pronounsstring
provider_web_linkstring
sexstring
suffixstring
terms_acceptedboolean

Deprecated. Whether the current version of the practice's migrated legacy patient contract was accepted. This does not reflect acceptance of other patient documents. Returns false if no legacy contract exists.

terms_accepted_atstring date-time

Deprecated. When the current version of the migrated legacy patient contract was accepted. This does not reflect acceptance of other patient documents.

updated_atstring date-time
uses_tobaccoboolean

Changes

  • c9bda0d2dd87Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      response property items/patient_agreement_accepted deprecated

    • info

      response property items/patient_agreement_accepted_at deprecated

    • info

      response property items/terms_accepted deprecated

    • info

      response property items/terms_accepted_at deprecated