Technical Docs
  • Introduction
  • Guides
    • Getting Started
    • Attribution Guidelines
    • Core Concepts
      • Adherence Score
      • Programs, Diets, and Rulesets
      • User Profile
      • Datasets
    • Tutorials and Walkthroughs
      • Creating a Meal Plan
      • Food Log Guide
      • Pagination
      • Executing Multiple Mutations
  • Knowledge Base
    • How-to guides
      • How to add desserts to your meal plan
      • How to log your custom recipe
      • How to generate a Meal Plan based on a template
    • Common errors
      • Meal Plan generation
    • FAQs
      • Getting Started on Suggestic
      • API and Authentication
      • Device Compatibility
      • Meal Plan
      • Nutrition
      • Programs
      • Recipes
  • HELPFUL RESOURCES
    • Deprecated Features
    • Glossary
    • Integrations
      • Building a No-code Meal Planning Application
        • Step 1: Creating the Integromat Scenario and Google Forms Connection
        • Step 2: Creating a User, Generating a Meal Plan, and Retrieving It
        • Step 3: Crafting Our PDF and Connecting PDFMonkey
        • Step 4: Sending The Document to Our User
  • Packages and SDKs
    • Node Package (NPM)
  • GraphQL
    • GraphQL Overview
    • Authentication
    • Calling GraphQL
    • GraphQL Playground
  • Changelog
    • 2025
      • March
  • Suggestic API Reference
    • Search
      • Food Log
        • Branded Foods Search
        • Common Foods Search
        • My Branded Food Search
        • My Common Foods Search
        • Food Search
        • Legacy
          • Autocomplete
          • Barcode Search
      • Recipe Search
        • Recipe Search
        • Recipe Search by Name or Ingredients
        • Recipe Search by Ingredients
      • Meal Plan Template Search
      • Profile Search
      • Restaurant Search
        • Restaurant Search by Location
        • Restaurant Search
    • Queries
      • Appointments
        • Upcoming Appointments
        • Past Appointments
        • Appointments Types
      • Assessments
        • Assessment Answers
        • Display Assessments
        • Supplement Recommendations
        • User Assessments
      • Content
        • Content Library
        • Content Categories
        • Content Tags
        • Journey
      • Food Log
        • Frequently Logged
        • Food Log Entries
        • Macros Aggregation
        • Micronutrients Aggregation
        • Macro Goals
        • Recently Logged
        • User's Foods and Recipes
          • User's Recipes
        • Legacy
          • Food Log Entries (Legacy)
          • Own Food Items
          • Own Food Item
          • Own Food Item by Id
          • Own Items
          • Own Recipe
          • Own Recipes
      • Lab Tests
        • Biomarker Categories
        • Biomarker Units
        • Biomarker Catalog
        • Biomarkers
        • Biomarker Results
        • Historical Biomarker Results
        • Historical Results by Biomarker
        • Lab Test Reports
        • Recommended Supplements
        • Recommended Articles
      • Meal Plan
        • Meal Plan
        • Custom Meal Plan
        • Simplified Meal Tracking
          • Meal Tracker
        • Meal Plan Config
        • Meal Planner (deprecated)
      • Program
        • All Programs
        • Program Details
      • Recipes
        • Equivalent Recipes (Macros)
        • Equivalent Recipes (Calories)
        • Recipe by Id
        • Recipes By MealTime
        • Recipes By Tag
        • Recipe Swap Options
        • Popular Recipes
        • Favorite Recipes
        • Premium Program Recipes
      • Restaurants
        • Restaurant By Id
        • Menu Items
        • Menu Item By Id
        • Menu Item by Program
        • Recommend Menu Items
      • Restrictions
        • Restrictions
        • Restriction by ID
      • Shopping List
        • Shopping List by Aisle
        • Shopping List by Recipes
      • Subscriptions
        • Subscription List
      • Supplement Plans
        • Supplement plan list
        • Supplement list
      • Tracking
        • Activity and Exercise
        • Checklists
          • Intake Checklist
        • Daily Recap
          • Get Daily Recap
          • Get Daily Recaps
          • Get Daily Recap Questions
          • Get Daily Mood Summary
        • Inisghts
        • Wellness Score
        • Sleep
          • Sleep Time
          • Sleep Quality Score
        • Steps
        • Water and Hydration
        • Heart Rate
        • HRV
        • Weight Tracker
      • USDA Food
      • Users
        • Users
        • User Profile
      • WGPT
        • Assistants
        • Journey
        • Guardrails
    • Mutations
      • Appointments
        • Update Appointment Credits
      • Assessments
        • New User Assessments
        • Set User Answers
      • Content
        • Mark Content as Read
      • Feedback
      • Food Log
        • Log Entries
          • Food Log
            • Add a Food Log Entry
            • Delete a Food Log Entry
          • Meal Log (Legacy)
            • Create Log Entry
            • Update Log Entry
            • Remove Log Entry
        • User's Foods and Recipes
          • Create a User Recipe
          • Create my Branded Food
          • Create my Common Foods
          • Update a User Recipe
          • Delete a User Recipe
          • Legacy: "Own" Recipe
            • Create "Own" Recipe
            • Update "Own" Recipe
            • Remove "Own" Recipe
        • AI Food Log
          • Process Ai Food
        • Legacy (ownFoods and ownRecipes)
          • Create "own" Food Item
          • Update "own Food"
          • Remove "own" Food Item
      • Journey Status
        • Start Journeys
        • Journey Status
        • Toggle Task Completed
      • Lab Tests
        • Add Biomarker
        • Update Biomarker
        • Add Biomarker Result
        • Add Biomarker Category
        • Update Biomarker Category
        • Remove Biomarker Category
        • Add Lab Test Report
        • Delete Lab Test Report
        • Update Lab Test Report
        • Create Recommended Supplement
        • Update Recommended Supplement
        • Remove Recommended Supplement
        • Create Recommended Article
        • Update Recommended Article
        • Remove Recommended Supplement
      • Meal Plan
        • Create Meal Plan Template
          • Custom Options
          • From Days
          • From Scratch
        • Assign a Meal Plan Template to a User
        • Generate Simple Meal Plan
        • Generate Meal Plan
        • Start Over Meal Plan
        • Swap Meals
        • Simplified Meal Tracking
          • Create a Meal Tracker Entry
        • Remove Meal Plan
        • Remove Meal Plan Recipe
      • Recipes
        • Add new recipe
        • Add Favorite Recipe
      • Shopping List
        • Add Multiple Recipes to the Shopping List
        • Add a Recipe to the Shopping List
        • Bulk Check/Uncheck Items
        • Check/Uncheck an Item
        • Clear Checked Items
        • Clear Shopping List
        • Remove Recipe
        • Update Serving Number
      • Subscriptions
        • Update Subscription
      • Supplement Plans
        • Create supplement plan for user
        • Update user supplement plan
        • Add Supplement
        • Update Supplement
      • Tracking
        • Activity and Exercise
          • Add Exercise Entry
          • Delete Exercise Entry
        • Checklists
          • Create my Checklist Item
          • Delete my Checklist Item
        • Daily Recap
          • Create a daily recap question
          • Select Daily Recap Questions
          • Delete a Daily Recap Question
        • Sleep
          • Add Sleep Time
          • Add Sleep Quality Score
        • Steps
          • Add Steps Count
          • Delete Steps Count
        • Heart Rate
          • Add Heart Rate
          • Delete Heart Rate
        • HRV
          • Add HRV
          • Delete HRV
        • Water and Hydration
        • Weight
          • Add Weight Entry
          • Remove Weight Entry
        • User Tracker Goals
          • Create User Goal
          • Update User Goal
          • Remove User Goal
      • Users
        • Authenticate using a Magic Link
        • Create User
        • Custom Attributes
        • Delete a User Account
        • Login User
        • Merge User Accounts
        • Request Reset Password
        • Reset Password
        • Request Password Reset email
        • Sensitive Profile Attributes
        • Update Profile
        • Update User's Program
        • User's Restrictions
        • Update Meal Plan Settings
        • User's Goals
        • Legacy User Mutations
          • Legacy | User's Biomarkers
          • User's Meal Plan Settings (deprecated)
      • WGPT
        • Add user to journey
  • Objects
    • Appointments
      • Appointment
      • Appointment Type
      • Appointment Credit
      • Attendee
      • Coach
    • Common
      • User
      • Adherence
      • Aisle Name
      • CPC
      • CPCIngredientGroup
      • Meal Times
      • Menu Item
      • Own Serving
      • Own Nutrients
      • MacroNutrientsRangeInput
      • Range
      • Tracker
      • Restaurant
    • Food Logs
      • Food Filter
      • Ingredient Amount
      • Ingredients
      • Own Recipe Ingredient
      • Meal Type
      • Nutrients
        • Nutrient Enum
      • Portions
      • Servings
      • AI Food Log
        • Food Analysis
    • Meal Plan
      • Debug Meal Plan Conditions
      • Meal
      • Meal Plan Day
      • Maximum Time per Meal
      • Maximum Ingredient Count
      • Meal Plan Template
      • Simple Meal Plan Filters
    • Recipe
      • Recipe
        • Tags
        • Cuisines
      • Recipe Swap Options
      • Parsed Ingredient Lines
      • Nutritional Info
      • Nutrients Per Serving
      • Calories Per Serving
      • Relative Calories
      • Source
      • Ingredients
      • Units of Measurement
    • Lab Tests
      • Article
      • Biomarker
    • Supplement
    • Assessments
      • Question
      • Answer
    • Content
      • Content Library
      • Content Categories
      • Content Tag
    • WGPT
      • Journey
      • dayJourney
      • Interaction
  • Case Studies
    • Reverse Health Case Study
Powered by GitBook
On this page

Was this helpful?

  1. Suggestic API Reference
  2. Queries
  3. Users

User Profile

User's profile data

Use the myProfile query to return all profile data for the currently logged-in user including the information of the meal plan generated.

Available Fields

Field

Type

Description

id

ID

Profile ID

customAttributes

JSONString

biologicalSex

biologicalSex

The biological sex of the user. Valid values are MALE and FEMALE

birthdate

Date

The date of birth of the user. Format: YYYY-MM-DD

startingWeight

Float

The user's current weight. Expressed in Kilograms.

targetWeight

Float

The user's target weight. Expressed in Kilograms.

activityLevel

ActivityLevel

User's weekly activity level. Valid values are NOT_ACTIVE, EXERCISE_1 (1 - 2 times per week) and EXERCISE_2 (3+ times per week)

height

Float

The height of the user. Expressed in meters.

dailyCaloricIntakeGoal

Int

Calculated field. Available after goal-related inputs (weight, height, age, gender, etc.) have been set. dailyCaloricIntakeGoal = totalDailyEnergyExpenditure - caloricDeficit

caloricDifference

Int

totalDailyEnergyExpenditure

Int

Amount of daily energy expenditure.

basalMetabolicRate

Int

Base metabolic rate

program

Object that contains the details of a program.

language

String

User language preference. Returned values:

en: English

es: Spanish

restrictions

Object that returns the details of the restrictions for the current profile.

mealPlan

Object that retrieves the Meal Plan information.

favoriteCuisines

[String]

{
  myProfile {
    id
    age
    birthdate
    biologicalSex
    activityLevel
    startingWeight
    customAttributes
    targetWeight
    height
    weeklyWeightGoal
    goalsOn
    isImperial
    programName
    language
    restrictions {
      name
    }
    dailyCaloricIntakeGoal
    caloricDifference
    totalDailyEnergyExpenditure
    basalMetabolicRate
    program {
      databaseId
      name
      author
    }
    mealPlan {
      id
      day
      date
      meals {
        recipe {
          id
          name
        }
        meal
        calories
      }
    }
  }
}
{
  "data": {
    "myProfile": {
      "id": "a38fdfa0-e554-44d9-b37f-885a3c225ce0",
      "age": null,
      "birthdate": null,
      "biologicalSex": null,
      "activityLevel": null,
      "startingWeight": null,
      "customAttributes": null,
      "targetWeight": null,
      "height": null,
      "weeklyWeightGoal": null,
      "goalsOn": false,
      "isImperial": true,
      "programName": "Wheat Belly 10-Day Grain Detox",
      "language": "en",
      "restrictions": [
        {
          "name": "Gluten"
        }
      ],
      "dailyCaloricIntakeGoal": null,
      "caloricDifference": null,
      "totalDailyEnergyExpenditure": null,
      "basalMetabolicRate": null,
      "program": {
        "databaseId": "01bbd541-939b-4b85-8d90-48ff0b02d0ee",
        "name": "Wheat Belly 10-Day Grain Detox",
        "author": "Dr. William Davis"
      },
      "mealPlan": [
        {
          "id": "TWVhbFBsYW5EYXk6NDQyNmU0MDYtOTZkZi00ZGRiLTk3MGUtYmNjYzJmMmZlYzhk",
          "day": 7,
          "date": "2022-05-29 02:00:00+00:00",
          "meals": [
            {
              "recipe": {
                "id": "UmVjaXBlOjljOTMzZmVmLWE4MjgtNGM1Ni04YWYzLWQ3NTdlZTQ1MWJlNw==",
                "name": "Easy Breakfast Burrito"
              },
              "meal": "breakfast",
              "calories": 449.8631
            },
            {
              "recipe": {
                "id": "UmVjaXBlOjkyNWFiNDU5LWUyY2YtNDVlMy1hNmNhLTU1NTA1MmRiODhjNg==",
                "name": "Creamy Watercress And Avocado Smoothie"
              },
              "meal": "snack",
              "calories": 225.5427
            },
            {
              "recipe": {
                "id": "UmVjaXBlOjk0NGEzNzYwLTY5YWQtNGEyOC04NTIyLWQ1MWIxOTU3NjFlNA==",
                "name": "Mexican Salmon Salad"
              },
              "meal": "lunch",
              "calories": 452.3
            },
            {
              "recipe": {
                "id": "UmVjaXBlOmI3NzVmZGQwLTZlMDMtNDRhOS05NWQwLTBlZDBjNDMwNDEzMw==",
                "name": "Healthy & Delicious: Avocado Chicken Salad Recipe"
              },
              "meal": "dinner",
              "calories": 243.793242499998
            }
          ]
        },
        {
          "id": "TWVhbFBsYW5EYXk6ZGU1NzVmYTQtMmRmOS00M2RiLTg0NmQtY2JlNzM5NjY1NmJk",
          "day": 6,
          "date": "2022-05-28 02:00:00+00:00",
          "meals": [
            {
              "recipe": {
                "id": "UmVjaXBlOjY4NjA3ZjU2LWE4ZmMtNGYyMi1iMTQ2LTMyOTQyZGMzMGQ1MQ==",
                "name": "Green Paleo Shakshuka"
              },
              "meal": "breakfast",
              "calories": 360.313
            },
            {
              "recipe": {
                "id": "UmVjaXBlOjVmZWM4Mzg2LTY2OTItNGU1Zi1iYTZjLWFmYWUwOGFmNDA5Yg==",
                "name": "Tuna Stuffed Avocado"
              },
              "meal": "snack",
              "calories": 186.8918175
            },
            {
              "recipe": {
                "id": "UmVjaXBlOjNiOGU3MGUwLWYwODQtNGJhMC1iYzM0LWQ3YzZmYjcxYmM3YQ==",
                "name": "Detox Broccoli Soup"
              },
              "meal": "lunch",
              "calories": 495.344346686146
            },
            {
              "recipe": {
                "id": "UmVjaXBlOmU5MmQyZmVmLWM5NjgtNGYzNy1iOWNmLTQ0ZTVmMTI4MGIzYg==",
                "name": "Chili Chicken"
              },
              "meal": "dinner",
              "calories": 252.652016062349
            }
          ]
        },
        {
          "id": "TWVhbFBsYW5EYXk6YWE0ZDlhYmUtYzk2My00YTc2LTkyMzItY2M4YTQ3NmNkMGI4",
          "day": 5,
          "date": "2022-05-27 02:00:00+00:00",
          "meals": [
            {
              "recipe": {
                "id": "UmVjaXBlOjg0YjcxNDdjLTgzNTktNDRlMi1iNzY0LTg4Y2Q0MmM3YmE0YQ==",
                "name": "Lentil-Spinach Crepe"
              },
              "meal": "breakfast",
              "calories": 360.69185
            },
            {
              "recipe": {
                "id": "UmVjaXBlOmVkMWQ3MDVhLTBiYjAtNGQwYi04NWEzLTdmZjQ5MGRjOTYzMA==",
                "name": "Parsley-Garlic Scallops"
              },
              "meal": "snack",
              "calories": 206.346809800437
            },
            {
              "recipe": {
                "id": "UmVjaXBlOjUzZmQyOTRhLWE4NWEtNGFkNy1hMWY2LWE0Zjc1OWEyNGE1ZA==",
                "name": "Keto Spinach-Chia Soup"
              },
              "meal": "lunch",
              "calories": 511.686014289625
            },
            {
              "recipe": {
                "id": "UmVjaXBlOmZiYWEzOTBmLWZhOWUtNDM2NC1hMjZiLTBhNGIxZWJjZTdmMA==",
                "name": "Teriyaki Salmon With Gingery Chard"
              },
              "meal": "dinner",
              "calories": 254.7029288616
            }
          ]
        },
        {
          "id": "TWVhbFBsYW5EYXk6OTA2NjZhNmYtZDQ1Yy00MjRkLWEyNGYtMWU5OGRjZDY1NjYy",
          "day": 4,
          "date": "2022-05-26 02:00:00+00:00",
          "meals": [
            {
              "recipe": {
                "id": "UmVjaXBlOmY1OTYxNDQ1LTk3ZDQtNDc2Mi1iZWMwLTM3ZmZhMmFiZjZkMw==",
                "name": "Turkey Breakfast Sausage"
              },
              "meal": "breakfast",
              "calories": 419.001793364667
            },
            {
              "recipe": {
                "id": "UmVjaXBlOmEwZTVjNjQwLWJiZjktNDI1NC04ZGJhLWFhODVhMTM5ZGQ3MA==",
                "name": "Pesto Shrimp Salad"
              },
              "meal": "snack",
              "calories": 203.605598934879
            },
            {
              "recipe": {
                "id": "UmVjaXBlOjk2YzQ0OWM3LTYxODQtNDdhNC04ZjU1LWZjMmZlODU0OGY5YQ==",
                "name": "Mulligatawny Vegetable Soup"
              },
              "meal": "lunch",
              "calories": 430
            },
            {
              "recipe": {
                "id": "UmVjaXBlOjI1ZDY1MmIyLTYzZjQtNDFkYi05N2VjLTRkYTU2ZjVmYzNhYg==",
                "name": "Domestic Diva'S Tilapia En Papillote With Cherry Tomatoes, Sweet Peppers & Olives"
              },
              "meal": "dinner",
              "calories": 266.041482749971
            }
          ]
        },
        {
          "id": "TWVhbFBsYW5EYXk6NGE1NjUwMjItMWI5NC00OTMzLWE5ZmYtOWUzOTI1NzNiOTEw",
          "day": 3,
          "date": "2022-05-25 02:00:00+00:00",
          "meals": [
            {
              "recipe": {
                "id": "UmVjaXBlOmRkNWI2YzY3LTVlYWQtNDQxYy1iMzhiLWE5NzI2NzMzYmExNA==",
                "name": "Fried Eggs In Tomato Sauce"
              },
              "meal": "breakfast",
              "calories": 418.802242464261
            },
            {
              "recipe": {
                "id": "UmVjaXBlOmQ4NjYzMjRiLTVmOGEtNGI0YS1iZTczLWVjNDQwOWU3NTMyNw==",
                "name": "Vegan Raita"
              },
              "meal": "snack",
              "calories": 154.538058333333
            },
            {
              "recipe": {
                "id": "UmVjaXBlOmJhM2QwNzM5LTJjNDktNGEwZS04MzRkLTE1MjZlZDY0YTY2Mg==",
                "name": "Shrimp Taco Lettuce Wraps"
              },
              "meal": "lunch",
              "calories": 535.401511272979
            },
            {
              "recipe": {
                "id": "UmVjaXBlOmQ4ZWVhZTUzLWQ1NWQtNDA1Zi05MzIxLWQ2ODNhMTgwOWMyMA==",
                "name": "Grilled Salmon Kabobs"
              },
              "meal": "dinner",
              "calories": 248.234334718669
            }
          ]
        },
        {
          "id": "TWVhbFBsYW5EYXk6Y2I1ZjA2OGMtZjc1Mi00Njc4LWI2NmMtODkyOTY5NmFjOWVm",
          "day": 2,
          "date": "2022-05-24 02:00:00+00:00",
          "meals": [
            {
              "recipe": {
                "id": "UmVjaXBlOjU2NjAxY2JjLWUxZjgtNDcwYy04NTlkLTNjYTdlYTFjZWYwYQ==",
                "name": "Green Shakshuka"
              },
              "meal": "breakfast",
              "calories": 392
            },
            {
              "recipe": {
                "id": "UmVjaXBlOjNhNDEzOWU1LTk1MWQtNGU0ZC1iNjMwLWE2MzQ0MTQxZGVkOQ==",
                "name": "Asparagus And Tomatoes"
              },
              "meal": "snack",
              "calories": 152.52872066
            },
            {
              "recipe": {
                "id": "UmVjaXBlOmZjM2RjOWRiLWQ1MjAtNDBjNi1hYjFmLTBlZjY4YzFhMmUxYg==",
                "name": "Thai Coconut Turkey"
              },
              "meal": "lunch",
              "calories": 565.19286145526
            },
            {
              "recipe": {
                "id": "UmVjaXBlOjFhNzZiMzI3LTg4MDktNDY0MC05ZWUyLWMwNDk3NTkxYzgxZg==",
                "name": "Seared Scallops With A Spicy Avocado And Coriander Raita"
              },
              "meal": "dinner",
              "calories": 250.370068696095
            }
          ]
        },
        {
          "id": "TWVhbFBsYW5EYXk6NjIxMWIzYmYtNWVmYS00NDhmLTg2MmUtN2FhMzg0NmU2MmJh",
          "day": 1,
          "date": "2022-05-23 02:00:00+00:00",
          "meals": [
            {
              "recipe": {
                "id": "UmVjaXBlOjNlZDAzN2Y3LWQ4OTItNGNjYy1iMjhjLTU5ODQ2Y2NiMWNkMQ==",
                "name": "Chickpea Flour Omellete With Asparagus"
              },
              "meal": "breakfast",
              "calories": 389.745916328333
            },
            {
              "recipe": {
                "id": "UmVjaXBlOmI5ZTBjMTUwLTJlNjMtNGZlZi1hMThlLWRjNzczNjFiNTBlZA==",
                "name": "Marinated Cherry Tomato And Herb Salad"
              },
              "meal": "snack",
              "calories": 215.308091925333
            },
            {
              "recipe": {
                "id": "UmVjaXBlOjc1YjBhODY3LTk3YmUtNGQ5NC1hOTliLThiNjNlZWI4ZjNkNg==",
                "name": "Pesto-Vegetable Frittata"
              },
              "meal": "lunch",
              "calories": 462.375
            },
            {
              "recipe": {
                "id": "UmVjaXBlOjc1NjBlYjIwLTY4ODQtNGRhZi04OTM0LWM1MjBmNDMzMjYyMw==",
                "name": "Roasted Italian Herb Chicken"
              },
              "meal": "dinner",
              "calories": 240.885511784
            }
          ]
        }
      ]
    }
  }
}
PreviousUsersNextWGPT

Last updated 1 year ago

Was this helpful?

Get all the attributes which where created with the mutation

User's favorite .

createProfileCustomAttributes
Program
Restrictions
MealPlanDay
cuisines