Sign in
patient

Get list of clinics this patient belongs to

get/patients/{patient_id}/clinics

Path parameters

patient_idinteger required

Response

successful operation

addressstring nullable

Street address where the clinic is located

citystring nullable
clinic_addressstring nullable
clinic_emailstring nullable
clinic_logo_urlstring nullable
clinic_phone_numberstring nullable
clinic_postal_codestring nullable
clinic_state_provincestring nullable
clinic_type'corporate' | 'research' | 'collaboration' | 'wellness' | 'obesity' | 'diabetes' | 'metabolic syndrome' | 'weight loss' | 'migraine' | 'gastroesophageal reflux' | 'gi discomfort' | 'vertigo' | 'sleep apnea' | 'rxlife' | 'dexcom' | 'menopause' required
clinic_websitestring nullable
config_add_default_goals_to_new_patientsboolean nullable
config_add_default_tips_to_new_patientsboolean nullable
countrystring nullable

Clinic mailing country when set; otherwise hospital country when available (Canada or USA)

created_timestring date-time required
default_report_templatestring[]
descriptionstring nullable
full_namestring nullable

Full/legal clinic name

hospital_idinteger required
hospital_namestring nullable

Name of the hospital this clinic belongs to

idinteger required
is_disabledboolean
namestring required
receive_report_notificationboolean nullable
receive_report_pdf_by_emailboolean nullable
report_template_sectionsobject nullable
statestring nullable

Region / state / province (structured address)

updated_timestring date-time required
zip_codestring nullable

Example response

[
  {
    "default_report_template": [
      "clinical_summary_statement",
      "calories_by_period",
      "carbs_by_period",
      "fasting_windows",
      "average_plate_serv",
      "macronutrient_distribution",
      "micronutrient_summary_table",
      "diet_quality_score",
      "carbohydrate_frequency",
      "GI_food_list",
      "glycemic_index_frequency",
      "average_fats_frequency",
      "average_beverage_frequency",
      "average_grains_frequency",
      "average_proteins_frequency",
      "food_dump",
      "supplements"
    ],
    "flags": {
      "clinic_default_days_until_report_date": "30",
      "clinic_default_patient_age": "30",
      "clinic_default_patient_sex": "female",
      "clinic_default_report_include_supplements_in_food_dump": true,
      "clinic_default_report_include_supplements_in_rdi": true,
      "clinic_default_subscription_name": "three-day",
      "clinic_default_user_locale": "en",
      "clinic_invitation_email_cadence": "1,2,7,14",
      "clinic_maximum_meal_capture_period_in_days_before_subscription": "0",
      "clinic_report_identity_mode": "anonymous",
      "clinic_report_judge_confidence_min": "0.7",
      "clinic_subscription_reminder_email_cadence": "1,7,-30",
      "clinic_subscription_types": "single",
      "clinician_oversight_of_patient": "clinician",
      "clinician_prevent_new_patients_after_date": "2020-01-01",
      "email_template_id_clinic_logging_completion": "en:xxx",
      "email_template_id_clinic_logging_starts_tomorrow": "en:xxx",
      "email_template_id_clinic_onboarding": "en:xxx",
      "email_template_id_clinic_registered_but_no_meals": "en:xxx",
      "email_template_id_clinic_reminder_to_continue_logging": "en:xxx",
      "email_template_id_clinic_report_available": "en:xxx",
      "email_template_id_clinic_thirty_day_subscription_inactive_logging_reminder": "en:xxx",
      "email_template_id_clinic_upcoming_subscription": "en:xxx",
      "email_template_id_returning_invitation": "en:xxx",
      "lifecycle_messaging_variant_patient_invited": "clinician",
      "lifecycle_messaging_variant_patient_logging_completed": "clinician",
      "lifecycle_messaging_variant_patient_report_available": "clinician",
      "lifecycle_messaging_variant_patient_subscription_notification": "clinician",
      "lifecycle_messaging_variant_patient_subscription_reminder": "clinician",
      "patient_app_extended_logging_types": "exercise, insulin",
      "patient_app_hide_meal_after_n_hours": "5",
      "patient_app_key_nutrients": "protein_g, fat_g, default_carbs_g, energy_kcal",
      "patient_app_nutritional_insights": true,
      "patient_app_nutritional_insights_sections_to_hide": "ultraprocessed foods",
      "patient_app_partner_branding": "dexcom",
      "patient_app_partner_oauth_provider": "dexcom",
      "patient_app_primary_macronutrient": "default_carbs_g",
      "patient_app_primary_macronutrient_can_edit": true,
      "patient_app_show_dev_settings": true,
      "patient_app_show_diet_score": true,
      "patient_app_show_macro_nutrition_card": true,
      "patient_app_show_nutrition_data_and_insights": true,
      "patient_app_use_timeline": true,
      "patient_app_use_v3_ui": true,
      "patient_can_view_pdf_reports": true,
      "patient_default_measure_system": "metric, imperial, auto, or none",
      "patient_goals_can_edit": true,
      "patient_preferred_nutrition_source": "usda",
      "patient_show_cals": true,
      "patient_show_carbs": true,
      "patient_show_gender": true,
      "patient_show_total_carbs": true,
      "patient_use_exercise": true,
      "patient_use_medication": true,
      "patient_use_question": true,
      "patient_use_sleep": true
    }
  }
]

Changes

Changed in 2 of the 15 revisions of this API.2

  • a61b77b30e631See the full diff
    • ○

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

      response-optional-property-added

  • f06884d9c0931See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added