Circle V2 API Docs
    Preparing search index...

    Interface Patients

    Table "patients" (customer), schema v2. Rows keep their source record ids; record_id (rec prefix) resolves via records.get().

    interface Patients {
        address: string | null;
        birthday: string | null;
        city: string | null;
        created_at: string | null;
        email: string | null;
        gender: string | null;
        insync_patient_id: string | null;
        name: string | null;
        patient_id: string | null;
        phone: string | null;
        primary_provider: string | null;
        region: string | null;
        status: string | null;
    }
    Index

    Properties

    address birthday city created_at email gender insync_patient_id name patient_id phone primary_provider region status

    Properties

    address: string | null

    Street address as one line

    birthday: string | null

    Date of birth, for sources that keep one on the customer (a member, a patient, a client) ISO 8601 date string.

    city: string | null

    City, town, or district of the address

    created_at: string | null

    When the customer was created in the source ISO 8601 date string.

    email: string | null

    Primary email address

    gender: string | null

    One of: female, male, other. Map the source labels onto these; the raw label stays in source data

    insync_patient_id: string | null
    name: string | null

    Full customer name

    patient_id: string | null
    phone: string | null

    Primary phone number

    primary_provider: string | null
    region: string | null

    State, province, or region of the address, as the source names it

    status: string | null

    One of: prospect, active, inactive. Map the source lifecycle (archived, disabled, deleted, lead) onto these; the raw label stays in source data

    Settings

    Member Visibility

    On This Page

    Properties