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
  • List of Fields
  • Simple Example
  • Full Example

Was this helpful?

  1. Objects
  2. Recipe

Recipe

Fields and details of the recipe object

PreviousRecipeNextTags

Last updated 3 years ago

Was this helpful?

List of Fields

Please note that fields not documented here may be out of date or deprecated. Not finding what you are looking for? Shoot us an .

Field

Type

Note

id

ID!

The recipe's id

databaseId

String

The database id of the recipe

totalTime

String

Total preparation and cooking time in text format

E.g., 5 minutes

totalTimeInSeconds

Int

Total preparation and cooking time in seconds

name

String

Name of the recipe

numberOfServings

Int

Original recipe number of servings

ingredientsCount

Int

Quantity of ingredients in the recipe

ingredients

List of the recipe's ingredients

ingredientLines

[String]

Complete ingredient lines including quantity

E.g. 1/4 cup coconut oil, melted

parsedIngredientLines

Structured representation of the ingredient lines

language

String

Language code of the recipe

courses

[String]

Tags representing the courses associated with the recipe.

cuisines

[String]

Tags representing the cuisines associated with the recipe.

mealTags

String

Tags representing the meal of the day of the recipe. Options are: "Breakfast", "Lunch", "Dinner", "Snack", "Snacks", "Side dishes".

source

Source information for the recipe, including the source's URL

mainImage

String

URL of recipe's main image

author

String

Recipe's author-name

authorAvatar

String

URL of the image representing the author of the recipe

adherence (deprecated)

Float

adherenceDetails

isUserFavorite

Boolean

Has this recipe been marked as a favorite by the user

inUserShoppingList

Boolean

Is this recipe currently contained in the user's shopping list

weightInGrams

Float

Total weight of the recipe expressed in grams

servingWeight

Float

Weight, in grams, of each serving

isLogged

Boolean

True if the recipe has been recently logged by the requesting user

instructions

[String]

An array of cooking instruction lines.

nutritionalInfo

Nutritional information per gram of recipe. For most use cases, the nutrientsPerServing object should be preferred.

nutrientsPerServing

Nutritional information per serving

caloriesPerServing

Per serving caloric value of each nutrient

sourceUrlWorks (deprecated)

Boolean

True if the URL is working. Otherwise displays False. There are meal plans already created show recipes with URLs not working or invalid. This will help users to check recipes before rendering them to an external site.

externalId

String

Id of any external meal information which will help to associate the recipes in the external database with ours.

relativeCalories

Relative caloric value of each macronutrient as a percentage of total calories per serving.

Simple Example

{
  recipe(id: "UmVjaXBlOmFmMDkzMjQ0LWZkZTMtNGE3Yy1iMTA4LWUxODExNTBkNmNiZQ==") {
    name
    author
    nutritionalInfo {
      calories
      protein
      carbs
      fat
    }
  }
}
{
  "data": {
    "recipe": {
      "name": "Tropical Storm Detox Shake",
      "author": "Dr. William Davis",
      "nutritionalInfo": {
        "calories": 1.48,
        "protein": 0.01,
        "carbs": 0.09,
        "fat": 0.13
      }
    }
  }
}

Full Example

{
  recipe(id: "UmVjaXBlOjA2YjM1ODcwLTNlYTctNDYxZC1iZGMwLWIwNmY1ZGZmOTJhMw==") {
    databaseId
    totalTime
    totalTimeInSeconds
    name
    rating
    numberOfServings
    ingredientLines
    ingredients {
      name
    }
    language
    courses
    cuisines
    source {
      siteUrl
      displayName
      recipeUrl
    }
    mainImage
    isPremium
    isFeatured
    author
    authorAvatar
    ingredientsCount
    favoritesCount
    isUserFavorite
    inUserShoppingList
    weightInGrams
    servingWeight
    isLogged
    relativeCalories {
      carbs
      fat
      protein
      fat
    }
    instructions
    nutritionalInfo {
      calories
      protein
      carbs
      fat
      sugar
      fiber
      saturatedFat
      monounsaturatedFat
      polyunsaturatedFat
      transFat
      cholesterol
      sodium
      potassium
      vitaminA
      vitaminC
      calcium
      iron
      netcarbs
    }
  }
}
{
  "data": {
    "recipe": {
      "databaseId": "06b35870-3ea7-461d-bdc0-b06f5dff92a3",
      "totalTime": "30 minutes",
      "totalTimeInSeconds": 1800,
      "name": "Garlic-Seafood Stew",
      "rating": null,
      "numberOfServings": 2,
      "ingredientLines": [
        "1 tbsp olive oil",
        "1 small onion, diced",
        "5 garlic cloves, minced",
        "14 oz can diced tomatoes",
        "1 cup clam juice",
        "1 bay leaf",
        "1 tsp salt",
        "5 oz clams",
        "6 oz mussels",
        "4 oz shrimp, peeled and deveined",
        "3 oz calamari, sliced into rings",
        "2 tbsp chopped parsley"
      ],
      "ingredients": [
        {
          "name": "Olive oil"
        },
        {
          "name": "Onion"
        },
        {
          "name": "Garlic cloves"
        },
        {
          "name": "Tomatoes"
        },
        {
          "name": "Clam juice"
        },
        {
          "name": "Bay leaf"
        },
        {
          "name": "Salt"
        },
        {
          "name": "Clam"
        },
        {
          "name": "Mussels"
        },
        {
          "name": "Shrimp"
        },
        {
          "name": "Calamari"
        },
        {
          "name": "Parsley"
        }
      ],
      "language": null,
      "courses": [],
      "cuisines": null,
      "source": null,
      "mainImage": "https://storage.googleapis.com/sg-uploads/a97716f2e53c45c4be16d617de6c98e8.jpg",
      "isPremium": null,
      "isFeatured": null,
      "author": "Suggestic Premium",
      "authorAvatar": "https://sg-data.storage.googleapis.com/author/suggestic-premium.png",
      "ingredientsCount": 12,
      "favoritesCount": 1,
      "isUserFavorite": false,
      "inUserShoppingList": false,
      "weightInGrams": 1359.48474,
      "servingWeight": 679.74237,
      "isLogged": false,
      "relativeCalories": {
        "carbs": 0.2728,
        "fat": 0.2892,
        "protein": 0.438
      },
      "instructions": [
        "In a large stock pot, heat oil over medium high heat. Add the onions and cook for 3 minutes. Add garlic and saute for another minute.",
        "Add 1 cup of water, tomatoes, clam juice, bay leaf and salt. Bring to a boil, then reduce heat to medium and simmer for 20 minutes.",
        "Add in all the seafood at once and stir to combine. Cook until shrimp is pink and cooked through and mussels and clams have opened, about 7 minutes.",
        "Garnish with parsley and serve immediately"
      ],
      "nutritionalInfo": {
        "calories": 0.5185,
        "protein": 0.0568,
        "carbs": 0.0354,
        "fat": 0.0167,
        "sugar": 0.0126,
        "fiber": 0.0035,
        "saturatedFat": 0.0024,
        "monounsaturatedFat": 0.0081,
        "polyunsaturatedFat": 0.0021,
        "transFat": 0,
        "cholesterol": 0.3353,
        "sodium": 3.6826,
        "potassium": 1.2871,
        "vitaminA": 0,
        "vitaminC": 0.2328,
        "calcium": 0.2102,
        "iron": 0.0111,
        "netcarbs": 0.03
      }
    }
  }
}

[]

for the recipe

Explain the recipe's and the reasoning behind it

If this field is null then it means it is a "" and you should redirect to the recipeURL in the object.

email
Ingredient
IngredientLine
Source
Adherence Score
Adherence
Adherence Score
recipe from the internet
source
NutritionalInfo
nutrientsPerServing
caloriesPerServing
RelativeCalories