oauth
mfa

Get auth token (with mfa support)

post/oauth/authorize

Response

successful operation

messagestring nullable
reason'auth_failed' | 'inactive_user' | 'mfa_token_required' | 'secure_token_invalid' | 'token_invalid' | 'sudo_failed' nullable
successboolean required

Example response

{
  "clinician": {
    "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

No recorded changes to this endpoint across all 1 revision of this API.