Supplement plan list
Use the supplementPlans
query to get all supplement plans assigned to an user.
Arguments
id
ID
Supplement plan Id.
first
Int
Retrieves the first results from the list.
last
Int
Retrieves the last results from the list.
after
String
before
String
Available fields
name
String
Supplement plan name.
isActive
Boolean
True sets the supplement plan active for the user, otherwise False.
visibility
Boolean
True makes the supplement plan visible for the user, otherwise False.
coach
ID
Id of Coach.
startDate
Date
Sets the starting date for the supplement plan. YYYY-MM-DD
createdAt
DateTime
Supplement plan creation date. YYYY-MM-DDT hh:mm:ssZ
nutrition
String
Open text field.
resources
String
Open text field.
overview
String
Open text field.
exercise
String
Open text field.
supplements
[Supplements]
Supplement or list of supplements. (Refer to example below)
supplements.supplementId
ID
Id of supplement.
supplements.length
Int
Length duration of supplement.
supplements.directionsOfUse
SupplementDirection
Direction of use for supplement.
supplements.directionsOfUse.quantity
Float
Supplement quantity.
supplements.directionsOfUse.timeOfDay
TimeOfDay
enum TimeOfDay { AT_BEDTIME AT_WAKING WITH_BREAKFAST WITH_DINNER WITH_LUNCH }.
supplements.<DAYOFWEEK>
Boolean
Can be any day of the week ex. sunday: true
protocols
[SupplementPlanProtocol]
Protocol or list of protocols. (Refer to example below)
protocols.protocolId
ID
Id of Protocol.
protocols.isActive
Boolean
True sets the protocol active for the user, otherwise False.
protocols.directionsOfUse
SupplementDirection
Direction of use for protocol.
protocols.directionsOfUse.quantity
Float
Protocol quantity.
protocols.directionsOfUse.timeOfDay
TimeOfDay
enum TimeOfDay { AT_BEDTIME AT_WAKING WITH_BREAKFAST WITH_DINNER WITH_LUNCH }.
protocols.<DAYOFWEEK>
Boolean
Can be any day of the week ex. sunday: true
Example
Last updated