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
      • April
  • 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
  • Arguments
  • Available Fields
  • Example
  • Considerations

Was this helpful?

  1. Suggestic API Reference
  2. Queries
  3. Meal Plan

Custom Meal Plan

Generates a Custom Meal Plan based on a daily caloric goal, macro ratios, and the user's profile.

PreviousMeal PlanNextSimplified Meal Tracking

Last updated 2 years ago

Was this helpful?

The customMealPlan query will return a list of days with a number of meals, based on the arguments below. Each meal contains a with all its expected properties along with the amount of recommended servings.

Arguments

Arguments

Type

Description

calories

Int!

Total Calories per day

carbs

Float!

Percent of Carbs

protein

Float!

Percent of Protein

fat

Float!

Percent of Fat

omega3

Float

Percent of Omega 3. If not included, the planner ignores this constraint.

days

Float

Length of meal plan (in days)

format

MealTimeType

Requested meals per day format, Available options are: BREAKFAST, SNACK, LUNCH, DINNER

error

Float!

Margin of error (as a percentage) for calories and macros. Default: 0.05

breakfastDistribution

Float

Percentage of the daily calories goal that each breakfast covers.

lunchDistribution

Float

Percentage of the daily calories goal that each lunch covers.

dinnerDistribution

Float

Percentage of the daily calories goal that each dinner covers.

snackDistribution

Float

Percentage of the daily calories goal that each snack covers.

maxTimeMinutes

Object that returns the maximum values for each meal. Expressed in minutes.

For example, maximum preparation time for the following meals:

  • breakfast: 15

  • lunch: 30

  • dinner: 40

  • snack: 30

maxIngredientsCount

Object that returns the maximum values for each meal. Expressed in minutes.

For example, maximum ingredient count for the following meals:

  • breakfast: 7

  • lunch: 5

  • dinner: 5

  • snack: 6

Available Fields

The following fields will be displayed in the response:

Field name

Type

Note

day

Int

The number of days in the returned meal plan.

calories

Float

Total calories (in Kcal) for the day.

meals

Example

{
  customMealPlan(
    calories: 1600
    carbs: 0.45
    protein: 0.25
    fat: 0.3
    days: 1
		format: [BREAKFAST, LUNCH, DINNER]
		breakfastDistribution: 0.3
      maxTimeMinutes:{
      breakfast:10,
      dinner:8,
      snack:5,
      lunch:3
    }
  ) {
    day
    calories
    meals {
      id
      meal
      numOfServings
      calories
      recipe {
        id
        databaseId
        name
	numberOfServings
        nutrientsPerServing {
          calories
        }
        
      }
    }
  }

  }
  
  
{
  "data": {
    "customMealPlan": [
      {
        "day": 1,
        "calories": 1608.8731844830427,
        "meals": [
          {
            "id": null,
            "meal": "Breakfast",
            "numOfServings": 2,
            "calories": 514.5982545763253,
            "recipe": {
              "name": "Carrot,Ginger And Plum Juice",
              "id": "UmVjaXBlOjVkMjg3NjA5LTdlODYtNDQ4ZC1iZTkwLWU3MDdkNjlkNTkyMQ==",
              "databaseId": "5d287609-7e86-448d-be90-e707d69d5921",
              "numberOfServings": 2,
              "nutrientsPerServing": {
                "calories": 257.3
              }
            }
          },
          {
            "id": null,
            "meal": "Lunch",
            "numOfServings": 2,
            "calories": 784.672,
            "recipe": {
              "name": "Homemade Chicken Ham Recipe",
              "id": "UmVjaXBlOmVkZWM0MzYzLTYwNTctNGY5OS1iOGRhLTk1N2VhZjJhOGI1MA==",
              "databaseId": "edec4363-6057-4f99-b8da-957eaf2a8b50",
              "numberOfServings": 2,
              "nutrientsPerServing": {
                "calories": 392.34
              }
            }
          },
          {
            "id": null,
            "meal": "Dinner",
            "numOfServings": 2,
            "calories": 309.60292990671724,
            "recipe": {
              "name": "Roasted Butternut Squash Green Bean Casserole Recipes",
              "id": "UmVjaXBlOmI5NTgxMDk5LTgyZGQtNDVlYS04ZWE2LTk1NTU3MGY5YThmMw==",
              "databaseId": "b9581099-82dd-45ea-8ea6-955570f9a8f3",
              "numberOfServings": 8,
              "nutrientsPerServing": {
                "calories": 154.8
              }
            }
          }
        ]
      }
    ]
  }
}

It may occur that meal plan service times out and generates fewer days than requested, if this happens please review your constraints, as too many restrictions may significantly reduce the universe of suitable recipes.

Considerations

  • A margin of error has been set for the resulting meal plan for both calories and macronutrients.

  • No meal repeats on the same day.

  • This query takes into account the user's program and preferences.

  • A number of quality-related filters have been set, by default, in order to ensure high-quality meal plans:

    • Excludes recipes for desserts, sauces, dips, bread, cocktails, and similar.

    • Excludes recipes with under 40 calories per serving.

    • Excludes snacks with over 5 ingredients.

    • Excludes recipes with over 15 servings.

    • Excludes recipes with more than 45-minute of cooking and preparation time.

    • Excludes 0 calorie foods.

    • Excludes packaged foods.

[]

A along with the amount of recommended servings.

This query doesn't take into consideration a user's personal caloric goals. Use for that option.

Recipe
Meal Plan
maxTimeMinutes
maxIngredientsCount
Meal
Recipe