achievements4

admin32

advisor-chat7

auditor feedback3

bookmarks10

careteam7

cgm18

chef-admin3

clinic10

clinic link1

clinic_invitation1

clinician1

clinician link5

clinician tip3

clinician_guidance5

cliniko-booking9

daily consumption1

data review71

data_management23

database2

diet restrictions6

emotion6

emotional_health5

eval1

exercise7

food83

goal10

guided health3

health_data1

health_targets11

hospital34

image-detection1

insights2

internal26

internal_user1

meal31

meal_push_questions6

meal-plan20

meal-suggestions1

media2

medication5

metrics11

mindfulness5

mobile-proto1

motivations6

movano3

nft-summary1

nlp6

notification-engine1

nutrition2

nutrition-plan7

oauth9

openai3

partner4

partner-admin12

partner-oauth13

patient30

patient_report26

patientAppData5

patients5

patients onboarding6

privacy1

recipes56

reporting62

shopping15

sleep5

steps1

streak1

stress5

subscription16

substitution suggestion1

supplement4

support1

support meal trace1

support-help2

system1

tasks1

telemetry2

test1

testing6

translations1

user8

user-surveys4

water3

webhook12

weekly_reports4

weight5

patients onboarding

Endpoint to get patient's information to be used during onboarding process.

Changed on Oct 2, 2026

Unauthenticated and rate limited per client address. Profile fields are only returned for invited patients who have not registered yet; registered patients get only email, is_registered, locale and flags.

get/patients/onboarding/{patient_email}

Request

Base URL
https://api.rxfoodapp.com/api
URL
https://api.rxfoodapp.com/api/patients/onboarding/{patient_email}
Auth
none required

Path parameters

patient_emailstring required

Response

successful operation

Example response

{
  "birthday": "2019-01-02",
  "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,
    "user_require_password_strength": true
  },
  "subscriptions": [
    {
      "expiration_date": "2019-01-02",
      "name": "three-day",
      "report_date": "2019-01-05",
      "start_date": "2019-01-02"
    }
  ],
  "usage_summary": {
    "summary_statistics": {
      "date_since": "2020-05-02",
      "date_until": "2020-05-12",
      "tracking_reference_date": "2020-05-12"
    }
  }
}

Changes

Oct 2, 2026c3d8e22b22e8 Revision changes
- info
  added the optional property ///// to the response with the status
Sep 30, 2026c3fcbb0135ce Revision changes
- breaking
  added to the response body oneOf list for the response status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  added the non-success response with the status

Operation history (4 revisions)