About the GraphQL API

About GraphQL

The GraphQL data query language is:

  • A specification. The spec determines the validity of the schema on the API server. The schema determines the validity of client calls.

  • Strongly typed. The schema defines an API's type system and all object relationships.

  • Introspective. A client can query the schema for details about the schema.

  • Hierarchical. The shape of a GraphQL call mirrors the shape of the JSON data it returns. Nested fields let you query for and receive only the data you specify in a single round trip.

  • An application layer. GraphQL is not a storage model or a database query language. The graph refers to graph structures defined in the schema, where nodes define objects and edges define relationships between objects. The API traverses and returns application data based on the schema definitions, independent of how the data is stored.

Queries

In this section

About queries

Every GraphQL schema has a root type for both queries and mutations. The query type defines GraphQL operations that retrieve data from the server.

Arguments

Name Description

representations ([_Any])


Arguments

Name Description

assessmentId (ID!)

orderBy (UserAnswerOrderByInput)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID!)


Arguments

Name Description

filters (AnswersFilterInput)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

coachId (ID!)

start (DateTime)

end (DateTime)

filters (AppUserActivityLogFiltersInput)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID!)


Arguments

Name Description

filters (AssessmentsFilterInput)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

assistant (ID!)

filters (AssistantAnalyticFiltersInput)


Arguments

Name Description

filters (AssistantFiltersInput)


Arguments

Name Description

query (String)

query search term. Max: 3 words

mealType (MealType)

mealTypes ([MealType])

enter (Boolean)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

barcode (String!)


Arguments

Name Description

id (ID)

filters (BiomarkerFilterInput)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID)

parentId (ID)

filters (BiomarkerCategoryFilterInput)

orderBy (BiomarkerCategoryOrderBy)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

filters (BiomarkerResultsFilterInput)


Arguments

Name Description

id (ID)

filters (BiomarkerFilterInput)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

query (String)

barcode (String)

filter (FoodFilter)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

appointmentType (ID!)

start (DateTime!)

end (DateTime!)

coaches ([ID!])


Arguments

Name Description

id (ID)

filters (CoachTeamsFilterInput)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID)

filters (CoachTypesFilterInput)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

query (String)

filter (FoodFilter)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

name (String)


Arguments

Name Description

filters (ConstraintFilters)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID)

tags ([String!])

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID)

categories ([ID])

Filter by Categories IDs.

search (String)

Search content by title or subtitle.

order (ContentLibraryOrderBy)

Return content library ordered by creation date or popularity.

tags ([String!])

Filter by tags name.

enablePersonalizedContent (Boolean)

isRead (Boolean)

Fetch content read or not.

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

name (String)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

name (String)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

journeyId (ID)

id (UUID)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

program (ID)

calories (Int!)

protein (Float)

carbs (Float)

fat (Float)

omega3 (Float)

days (Int)

error (Float)

format ([MealTime]!)

maxTimeMinutes (IntValueByMealTime)

Max preparation time in minutes per meal time

maxIngredientsCount (IntValueByMealTime)

Max num of ingredients in recipe per meal time

breakfastDistribution (Float)

Percentage of the daily kcal goal that each breakfast covers

lunchDistribution (Float)

Percentage of the daily kcal goal that each lunch covers

dinnerDistribution (Float)

Percentage of the daily kcal goal that each dinner covers

snackDistribution (Float)

Percentage of the daily kcal goal that each snack covers

skipRecipes ([ID!])


Arguments

Name Description

id (ID)


Arguments

Name Description

filters (DrugNutrientInteractionsFilterInput)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

filters (EscalationFilters)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

programId (String)


Arguments

Name Description

id (ID!)

The ID of the object


Arguments

Name Description

userInput (String!)


Arguments

Name Description

fromDate (Date!)

toDate (Date!)

userId (String!)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

query (String)

barcode (String)

filter (FoodFilter)

isCommon (Boolean)

isBranded (Boolean)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (UUID)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID)

filters (GuardrailFilterInput)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

filters (HistoricalBiomarkerResultsFilterInput)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID!)

Biomarker ID


Arguments

Name Description

assistantId (ID!)


Arguments

Name Description

id (ID!)


Arguments

Name Description

assistantId (ID!)

search (String)


Arguments

Name Description

id (ID)

profile (ID)

isVisible (Boolean)

externalId (String)

orderId (String)

requisitionId (String)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

query (String!)

Query search term

lon (Float!)

longitude user geolocation -122.1272552

lat (Float!)

latitude user geolocation 37.4476243


log

Type: Logger

Arguments

Name Description

id (ID!)

The ID of the object


logs

Type: LoggerConnection

List and filter logs

Arguments

Name Description

user (String)

Filter by user email

sortBy (SortBy)

sorting field

sortOrder (SortOrder)

sorting order

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

date (Date!)


Arguments

Name Description

fromDate (Date!)

toDate (Date!)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

fromDate (Date!)

toDate (Date!)


Arguments

Name Description

fromDate (Date)

If received, the response will include two week before this date. Default is today.

fillDays (Boolean)

Complete the meal plan with empty days


mealPlannerByCustomFormat

Type: MealCustomPlannerDays

List of recipes ordered using custom format

Arguments

Name Description

format ([MealTime]!)


mealPlannerByDay

Type: MealPlannerDays

Meal planner by day

Arguments

Name Description

mealPlannerQueryType (MealPlannerQueryType!)


Arguments

Name Description

id (ID!)

The ID of the object


Arguments

Name Description

newerFirst (Boolean)

byCoach (ID)

excludeCoach (ID)

isPublic (Boolean)

search (String)

coachTypes ([ID!])

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID!)

The ID of the object


Arguments

Name Description

databaseId (String!)

Menuitem database UUID

programId (String!)

Program database UUID


Arguments

Name Description

restaurantId (String!)

Restaurant database UUID


Arguments

Name Description

restaurantId (String!)

Restaurant database UUID

programId (String!)

Program database UUID


menuitemSearch

Type: MenuItemConnection

Search for menu items

Arguments

Name Description

query (String)

Query search term

restaurantId (String)

course (String)

menu (String)

tags ([String])

meals ([String])

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

start (DateTime)

end (DateTime)

timezone (String)

labTestReportIds ([ID!])

excludeAppointmentsCanceled (Boolean)


Arguments

Name Description

id (String)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID)

excludeAppointmentCoaches (Boolean)

Exclude the coaches that have had an appointment with the user

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (String)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

categories ([ID])

search (String)

order (ContentLibraryOrderBy)

tags ([String!])

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

questionId (ID!)


Arguments

Name Description

id (ID)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)

eventId (ID)


Arguments

Name Description

fromDate (Date!)

toDate (Date!)


Arguments

Name Description

lon (Float!)

longitude user geolocation -122.1272552

lat (Float!)

latitude user geolocation 37.4476243


Arguments

Name Description

query (String)

query search term. Max: 3 words

mealType (MealType)

mealTypes ([MealType])

enter (Boolean)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID!)


Arguments

Name Description

fromDate (Date)

toDate (Date)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID!)


Arguments

Name Description

id (ID!)


Arguments

Name Description

fromDate (Date)

toDate (Date)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

start (DateTime)

end (DateTime)

before (String)

after (String)

first (Int)

last (Int)


popularRecipes

Type: RecipeConnection

Shows recipes with more historical likes/favorited

Arguments

Name Description

hidePurchasable (Boolean)

cuisines ([String!])

tags ([String!])

before (String)

after (String)

first (Int)

last (Int)


premiumProgramRecipes

Type: RecipeConnection

List users program recipes

Arguments

Name Description

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID!)

The ID of the object


Arguments

Name Description

orderBy (ProgramOrderBy)

filters (ProgramFiltersInput)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)

isActive (Boolean)

isPremium (Boolean)


Arguments

Name Description

id (ID!)


Arguments

Name Description

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

filters (QuestionsFilterInput)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


recipe

Type: Recipe

Arguments

Name Description

id (ID!)

The ID of the object


Arguments

Name Description

mealTime (RecipeMealTime)

dietaryTags ([DietaryTag])

hidePurchasable (Boolean)

maxPrepTime (Int)

Maximum preparation time in minutes

cuisines ([String!])

tags ([String!])

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

tag (String)

dietaryTags ([DietaryTag])

hidePurchasable (Boolean)

maxPrepTime (Int)

Maximum preparation time in minutes

before (String)

after (String)

first (Int)

last (Int)


recipeSearch

Type: RecipeConnection

Search for recipes

Arguments

Name Description

query (String)

Query search term

minPrepTime (Int)

Minimum preparation time in minutes

maxPrepTime (Int)

Maximum preparation time in minutes

tags ([String])

meals ([String])

cuisines ([String])

isPremium (Boolean)

totalTime (Float)

skillLevel (SkillLevel)

dietaryTag (DietaryTag)

program (String)

Optional program id

ingredients ([String])

macroNutrientsRange (MacroNutrientsRangeInput)

mealTime (RecipeMealTime)

numberOfIngredients (Int)

hasImage (Boolean)

hasInstructions (Boolean)

servingQuantity (Int)

filter (FoodFilter)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

recipeId (String)

serving (Int)


Arguments

Name Description

name (String)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

lon (Float!)

longitude user geolocation -122.1272552

lat (Float!)

latitude user geolocation 37.4476243


Arguments

Name Description

mealTime (RecipeMealTime!)

forSimpleMealPlan (Boolean)


Arguments

Name Description

id (ID!)

The ID of the object


Arguments

Name Description

query (String!)

Query search term

lon (Float!)

longitude user geolocation -122.1272552

lat (Float!)

latitude user geolocation 37.4476243


Arguments

Name Description

restaurantId (String!)

Restaurant database UUID


Arguments

Name Description

lon (Float)

longitude geolocation -122.1272552

lat (Float)

latitude geolocation 37.4476243

before (String)

after (String)

first (Int)

last (Int)


restaurantSearch

Type: RestaurantConnection

Search for restaurants

Arguments

Name Description

query (String)

Query search term

distance (Int)

Distance in Kilometers, Default 1km

stateProvince (String)

Filter by state. CA, TX

postalCode (String)

address (String)

lon (Float)

longitude geolocation -122.1272552

lat (Float)

latitude geolocation 37.4476243

gotAr (Boolean)

priceRating ([PriceRate])

geoBoundingBox (GeoBoundingBox)

cuisines ([String])

isOpen (Boolean)

show only open restaurants

program (String)

Optional program id

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

query (String)

Query search term

cuisine (String)

lon (Float!)

longitude user geolocation -122.1272552

lat (Float!)

latitude user geolocation 37.4476243

geolon (Float)

geolat (Float)

geoBoundingBox (GeoBoundingBox)

Optionally add a search bounding box


Arguments

Name Description

id (ID!)

The ID of the object


restrictions

Type: RestrictionConnection

All restrictions

Arguments

Name Description

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

email (String!)


Arguments

Name Description

query (String)

Query search term

cuisines ([String!])

tags ([String!])


Arguments

Name Description

mustIngredients ([String]!)

List of ingredients recipe must contain

before (String)

after (String)

first (Int)

last (Int)


serchForAllowedIngredient

Type: [CPCIngredient]

Is ingredient valid for users current program?

Arguments

Name Description

ingredient (String!)

Ingredient to search


Arguments

Name Description

offset (Int)

before (String)

after (String)

first (Int)

last (Int)

recipe (ID)


Arguments

Name Description

id (UUID)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

recipeId (ID!)

numberOfServings (Int)

size (Int)


Arguments

Name Description

recipeId (String)

serving (Int)

size (Int)


Arguments

Name Description

id (UUID)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID!)

The ID of the object


Arguments

Name Description

supplementId (ID!)


Arguments

Name Description

id (ID)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

assessmentId (ID!)

top (Int)


Arguments

Name Description

id (ID)

name (String)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

answer (String)

answerType (String)


Arguments

Name Description

question (String)

answers ([ID!])

group (DailyRecapQuestionGroup)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID)

goal (TrackerComponent)


trendingRecipes

Type: RecipeConnection

Shows recipes with more new likes/favorited

Arguments

Name Description

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

ndbNumber (String)


Arguments

Name Description

id (ID!)

Assessment ID

filters (UserAnswersByAssessmentInput)


Arguments

Name Description

assessmentId (ID!)


Arguments

Name Description

assessmentId (ID!)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

filters (UserAssessmentsFilterInput)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

profileId (ID)

consentTypeId (ID)


Arguments

Name Description

userUUIDs ([String!])

profileUUIDs ([String!])

subscriptionId (ID)

userEmails ([String!])

isTestUser (Boolean)

filters (UsersFiltersInput)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

filters (UsersProgressFilterInput)

offset (Int)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

id (ID!)


Arguments

Name Description

jwtToken (String!)

start (Date!)

end (Date!)

before (String)

after (String)

first (Int)

last (Int)


Arguments

Name Description

jwtToken (String!)

sessionId (String!)


Mutations

In this section

About mutations

Every GraphQL schema has a root type for both queries and mutations. The mutation type defines GraphQL operations that change data on the server. It is analogous to performing HTTP verbs such as POST, PATCH, and DELETE.

Arguments

Name Description

input (AcknowledgeConversationMessageInput!)

Return fields

Name Description

success (Boolean!)

message (String!)


Arguments

Name Description

input (AddBiomarkerInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

errors ([FormError!])

biomarker (Biomarker)


Arguments

Name Description

input (AddBiomarkerResultsInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

errors ([FormError!])


Arguments

Name Description

input (AddCoachChatConversationInput!)

Return fields

Name Description

success (Boolean!)

message (String!)


Arguments

Name Description

articleId (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)


Arguments

Name Description

recipes ([RecipeInShoppingList!]!)

Return fields

Name Description

success (Boolean!)

message (String!)


Arguments

Name Description

recipeIds ([String]!)

Return fields

Name Description

success (Boolean)

message (String)


Arguments

Name Description

recipeId (String!)

servings (Int)

Return fields

Name Description

success (Boolean)

message (String)


Arguments

Name Description

input (AddUserConsentInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

errors ([FormError!])


Arguments

Name Description

input (AddUserToJourneyInput!)

Return fields

Name Description

success (Boolean!)

message (String!)


Arguments

Name Description

input (AutoGenerateConversationMessageInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

generatedMessage (String)


Arguments

Name Description

appointment (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

appointment (Appointment)


Arguments

Name Description

day (Int!)

mealTime (MealTime!)

recipeId (String!)

Return fields

Name Description

recipe (Recipe)

success (Boolean)


Arguments

Name Description

input (CheckoutCreateInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

webUrl (String)


Return fields

Name Description

success (Boolean)


Return fields

Name Description

success (Boolean)


Arguments

Name Description

input (ConfirmFoodLogAssistantInput!)

Return fields

Name Description

success (Boolean!)

message (String!)


Arguments

Name Description

input (CreateAnswerInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

errors ([FormError!])

answer (AssessmentAnswer)


Arguments

Name Description

input (CreateAppointmentInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

appointment (Appointment)


Arguments

Name Description

input (CreateArticleRecommendedInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

errors ([FormError!])

articleRecommended (ArticleRecommended)


Arguments

Name Description

input (CreateAssessmentInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

errors ([FormError!])

assessment (Assessment)


Arguments

Name Description

input (CreateAssistantInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

errors ([FormError!])

assistant (Assistant)


Arguments

Name Description

assistantConversationInput (AssistantConversationInput!)

assistantId (ID!)

isInitial (Boolean!)

language (String)

profileId (ID!)

toneOfVoice (String)

useLongTermMemory (Boolean)

userMessage (String!)

Return fields

Name Description

success (Boolean!)

message (String!)

response (AssistantConversationResponse)


Arguments

Name Description

input (CreateBiomarkerCategoryInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

errors ([FormError!])

biomarkerCategory (BiomarkerCategory)


Arguments

Name Description

input (CreateCoachTeamInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

errors ([FormError!])

coachTeam (CoachTeam)


Arguments

Name Description

input (CreateCoachTypeInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

errors ([FormError!])

coachType (CoachType)


Arguments

Name Description

input (CreateContentCategoryInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

contentCategory (ContentCategoryType)

errors ([FormError!])


Arguments

Name Description

input (CreateContentLibraryInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

contentLibrary (ContentLibraryType)

errors ([FormError!])


Arguments

Name Description

name (String!)

Return fields

Name Description

success (Boolean!)

message (String!)

contentTag (ContentTagType)

errors ([FormError!])


Arguments

Name Description

input (CreateDailyRecapAnswerInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

dailyRecapAnswer (DailyRecapAnswer)

errors ([FormError!])


Arguments

Name Description

input (CreateDailyRecapQuestionInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

dailyRecapQuestion (ThirdPartyDailyRecapQuestion)

errors ([FormError!])


Arguments

Name Description

input (DayJourneyInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

dayJourney (DayJourneyType)


Arguments

Name Description

input (CreateDietPreferenceInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

errors ([FormError!])

dietPreference (DietPreference)


Arguments

Name Description

acknowledged (Boolean!)

autoRenewing (Boolean!)

orderId (String!)

packageName (String!)

productId (String!)

purchaseState (Int!)

purchaseTime (Float!)

purchaseToken (String!)

subscriptionSku (String!)

Return fields

Name Description

success (Boolean)

message (String)


Arguments

Name Description

input (CreateGuardrailInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

errors ([FormError!])

guardrail (Guardrail)


Arguments

Name Description

dayJourneyId (ID!)

deliveryTime (Time!)

goal (String!)

interaction (String!)

order (Int!)

Return fields

Name Description

success (Boolean!)

message (String!)

interaction (InteractionType)


Arguments

Name Description

input (JourneyInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

journey (JourneyAssistantType)


Arguments

Name Description

assistantId (ID!)

interactionId (ID!)

userMessage (String!)

Return fields

Name Description

success (Boolean!)

message (String!)

response (JourneyChatResponse)


Arguments

Name Description

assistantId (ID!)

category (KnowledgeBaseCategory)

metadata (GenericScalar)

name (String!)

pdfFile (Upload)

preProcess (Boolean)

sitemapUrl (String)

txt (String)

url (String)

Return fields

Name Description

success (Boolean!)

message (String!)

errors ([FormError!])

knowledgeBase (KnowledgeBaseType)


Arguments

Name Description

input (MessageInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

response (KnowledgeBaseChatResponse)


Arguments

Name Description

alert (Boolean)

alertAction (AlertAction)

alertStatus (AlertStatus)

alertText (String)

description (String)

externalId (String)

image (Upload)

imageUrl (String)

isVisible (Boolean)

labName (String!)

orderId (String)

orderingPhysician (String)

productId (String)

reportPdf (Upload)

requisitionId (String)

sampleCollectionDate (Date)

status (LabTestReportStatus)

testDate (DateTime)

testName (String!)

title (String)

userEmail (String)

videoUrl (String)

Return fields

Name Description

success (Boolean!)

message (String!)

report (LabTestReport)


Arguments

Name Description

customServingEquivalent (Float)

date (Date)

mealDatabaseId (String!)

mealTime (MealTime!)

mealType (MealType!)

quantity (Float!)

serving (Float)

time (Time)

Return fields

Name Description

success (Boolean)

databaseId (String)


Arguments

Name Description

coach (ID)

customOptions (MPTCustomOptionsInput)

description (String!)

fromDays (MPTFromDaysInput)

fromScratch (MPTFromScratchInput)

isPublic (Boolean)

name (String!)

Return fields

Name Description

success (Boolean!)

message (String!)

mealPlan (MealPlanTemplate)


Arguments

Name Description

input (CreateMyBrandedFoodInput!)

Return fields

Name Description

success (Boolean!)

message (String!)


Arguments

Name Description

directionsOfUse ([ItemDirectionsOfUseInput!])

header (String!)

tags ([String!])

text (String)

Return fields

Name Description

success (Boolean!)

message (String!)

myChecklistItem (MyChecklistItem)


Arguments

Name Description

input (CreateMyCommonFoodInput!)

Return fields

Name Description

success (Boolean!)

message (String!)


Arguments

Name Description

input (CreateMyRecipeInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

recipe (UserRecipe)


Arguments

Name Description

coach (ID)

eventId (ID)

text (String!)

title (String!)

Return fields

Name Description

success (Boolean!)

message (String!)

note (Note)


Arguments

Name Description

barcode (String)

brand (String)

date (Date)

logAfterCreation (Boolean)

mealTime (MealTime)

mealTimes ([MealTime])

mealType (MealType!)

name (String!)

ownNutrients (OwnNutrients!)

ownServing (OwnServing!)

Return fields

Name Description

success (Boolean)

message (String)

databaseId (String)


Arguments

Name Description

ingredients ([OwnRecipeIngredient])

logAfterCreation (Boolean)

quantity (Float!)

recipeName (String!)

Return fields

Name Description

success (Boolean)

databaseId (String)


Arguments

Name Description

cholesterolLdl (Float)

cortisol (Float)

ferritin (Float)

hba1c (Float)

totalCholesterol (Float)

vitaminB12 (Float)

vitaminD (Float)

Return fields

Name Description

success (Boolean)


Arguments

Name Description

append (Boolean)

attributes ([ProfileCustomAttribute!]!)

Return fields

Name Description

success (Boolean)

errors ([ErrorType])


Arguments

Name Description

input (CreateQuestionInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

errors ([FormError!])

question (AssessmentQuestion)


Arguments

Name Description

answers ([String]!)

result (String!)

Return fields

Name Description

success (Boolean)

errors ([ErrorType])


Arguments

Name Description

input (CreateSupplementInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

supplement (Supplement)


Arguments

Name Description

fromTemplate (ID)

input (CreateSPInput)

Return fields

Name Description

success (Boolean!)

message (String!)

supplementPlan (SupplementPlan)


Arguments

Name Description

input (CreateSupplementRecommendedInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

errors ([FormError!])

supplementRecommended (SupplementRecommended)


Arguments

Name Description

input (CreateThirdPartyGoalInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

goal (ThirdPartyGoal)


Return fields

Name Description

success (Boolean!)

message (String!)

jwt (String)


Arguments

Name Description

birthdate (Date)

email (String!)

emailPasswordNotification (Boolean)

extraData (JSONString)

name (String!)

password (String)

phone (String)

program (String)

restrictions ([ID!])

subscription (ID)

Return fields

Name Description

success (Boolean!)

message (String!)

user (User)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

answer (AssessmentAnswer)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean)

message (String)

email (String)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

articleRecommended (ArticleRecommended)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

assessment (Assessment)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

biomarker (Biomarker)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

biomarkerCategory (BiomarkerCategory)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

coachTeam (CoachTeam)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

coachType (CoachType)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

contentCategory (ContentCategoryType)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

contentLibrary (ContentLibraryType)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

contentTag (ContentTagType)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

dailyRecapAnswer (DailyRecapAnswer)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

dailyRecapQuestion (ThirdPartyDailyRecapQuestion)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

dietPreference (DietPreference)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

dynamicQuestion (AssessmentDynamicQuestion)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

guardrail (Guardrail)


Arguments

Name Description

interactionId (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

interaction (InteractionType)


Arguments

Name Description

assistantId (ID!)

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

report (LabTestReport)


Arguments

Name Description

coach (ID)

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

mealPlan (MealPlanTemplate)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

myChecklistItem (MyChecklistItem)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)


Return fields

Name Description

success (Boolean)

email (String)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)


Arguments

Name Description

noteId (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

note (Note)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

question (AssessmentQuestion)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

supplementRecommended (SupplementRecommended)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)


Arguments

Name Description

id (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)

mealPlan (MealPlanTemplate)


Arguments

Name Description

email (String!)

Return fields

Name Description

success (Boolean!)

message (String!)

magicLink (String)


Arguments

Name Description

addDays (Boolean)

appendDays (Int)

breakfastDistribution (Float)

Percentage of the daily kcal goal that each breakfast covers

dinnerDistribution (Float)

Percentage of the daily kcal goal that each dinner covers

fromTemplate (ID)

ignoreLock (Boolean)

includeFavorites (Boolean)

isAppend (Boolean)

isCache (Boolean)

kcalLimit (Float)

Upper kcal limit per meal, as a percentage of daily goal

lunchDistribution (Float)

Percentage of the daily kcal goal that each lunch covers

maxIngredientsCount (IntValueByMealTime)

Max num of ingredients in recipe per meal time

maxNumOfServings (Int)

Maximum number of servings per meal allowed in the meal plan

maxServingWeight (Int)

Maximum serving weight per meal allowed in the meal plan

maxTimeMinutes (IntValueByMealTime)

Max preparation time in minutes per meal time

minServingWeight (Int)

Minimum serving weight per meal allowed in the meal plan

repeat (DateTime)

snackDistribution (Float)

Percentage of the daily kcal goal that each snack covers

startDate (Date)

variety (MPVariety)

Return fields

Name Description

mealPlan ([MealPlanDay!])

success (Boolean)

True if the meal plan was successfully generated

message (String)

Error logs or info message. See "success"


Arguments

Name Description

input (GenerateShopifyMultipassUrlInput)

Return fields

Name Description

success (Boolean!)

message (String!)

url (String)


Arguments

Name Description

addDays (Boolean)

appendDays (Int)

boostAdherence (Boolean)

filters (SimpleMPFiltersInput)

format ([MealTime!])

ignoreLock (Boolean)

isAppend (Boolean)

repeat (DateTime)

variety (MPVariety)

Return fields

Name Description

success (Boolean)

True if the meal plan was successfully generated

message (String)

Error logs or info message. See "success"


Arguments

Name Description

input (GenerateVideoZoomTokenInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

token (String)

clientMutationId (String)


Arguments

Name Description

input (LinkUserAssessmentInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

userAssessment (Assessment)


Arguments

Name Description

userId (String!)

Return fields

Name Description

accessToken (String)

refreshToken (String)


Arguments

Name Description

input (MarkContentAsReadOrUnreadInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

errors ([FormError!])


Arguments

Name Description

input (MergeUserInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

errors ([FormError!])


Arguments

Name Description

input (NewUserAssessmentsInput!)

Return fields

Name Description

success (Boolean!)

message (String!)

userId (String)

externalId (String)

assessments (AssessmentConnection)


Arguments

Name Description

input (ProcessAppleReceiptInput!)

Return fields

Name Description

success (Boolean!)

message (String!)


Arguments

Name Description

activityLevel (ActivityLevel!)

biologicalSex (BiologicalSex!)

birthdate (Date!)

goalsOn (Boolean!)

height (Float!)

isImperial (Boolean)

startingWeight (Float!)

targetWeight (Float!)

weeklyWeightGoal (WeeklyWeightGoal!)

Return fields

Name Description

success (Boolean)

bmr (Int)

Basal Metabolic Rate

tdee (Int)

Total Daily Energy Expenditure

cd (Int)

Caloric Difference

dcig (Int)

Daily Caloric Intake Goal

bmi (Int)

Body Mass Index Goal

profile (ProfileType)


Arguments

Name Description

calories (Int!)

carbsPerc (Float!)

error (Float!)

fatPerc (Float!)

format ([MealTime])

omega3Perc (Float)

proteinPerc (Float!)

Return fields

Name Description

success (Boolean)


Arguments

Name Description

replace (Boolean)

restrictions ([ID])

List of restrictions to be added to a user profile

Return fields

Name Description

success (Boolean!)

message (String!)

restrictions ([ID!])


Arguments

Name Description

appVersion (String!)

client (String!)

eventType (EventType!)

location (GenericScalar)

timezone (String!)

Return fields

Name Description

success (Boolean)

message (String)


Arguments

Name Description

externalId (String)

profileId (String!)

recipeId (ID!)

Return fields

Name Description

success (Boolean)

message (String)


Arguments

Name Description

input (ReassignChatConversationInput!)

Return fields

Name Description

success (Boolean!)

message (String!)


Arguments

Name Description

input (RemoveCoachChatConversationInput!)

Return fields

Name Description

success (Boolean!)

message (String!)


Arguments

Name Description

articleId (ID!)

Return fields

Name Description

success (Boolean!)

message (String!)


Arguments

Name Description

recipeId (String!)

Return fields

Name Description

success (Boolean)

message (String)


Arguments

Name Description

databaseId (String!)