TeleWellness Portal
  • Introduction
  • HELPFUL RESOURCES
    • Getting Started
    • FAQ
      • Appointments
      • Meal Plan
  • User Management
    • Roles and Permissions
    • Manage Coaches
      • Coach tab
        • Register a new coach
          • Assign Members
        • Edit an existing coach
      • Calendar tab
        • Appointment Types
        • Appointment Alerts
      • Note Templates tab
    • Manage Members
      • Create a new member
      • Edit member's information
      • Filter members
  • Using the TeleWellness Portal
    • Login and logout to the Portal
    • Navigating the TeleWellness Portal
      • Home
      • Dashboard
      • Admin Dashboard
      • Coach Dashboard
        • Progress Tab
          • Filtering the information
          • Checking the user’s streak progress
          • Checking the user's activities progress
          • Showing the food log history
          • Checking the user's recap questions
          • Checking the user's weight log history
          • Showing user’s program journey
          • Checking user’s water intake history
        • Meal Plan tab
        • Notes tab
        • Appointments tab
        • Lab Tests tab
        • Wellness Plans tab
      • Messages
      • Meal Plans
        • Manage Meal Plans
          • From Scratch
          • Smart Meal Plan
      • Scheduling
      • Wellness Plan
        • Manage Protocols
        • Manage Wellness Plan Templates
    • Note Templates
  • API Reference
    • Generate Authorization Token
    • Appointments
      • Appointment Types
      • Add Appointment Credits
    • Coaches
      • Coach List
      • Update a Coach
      • Create a Coach
      • Invite Coach
    • Members
      • Member List
      • Members List
      • Program List
      • Update member's program
      • Assign Coach to Member
    • Lab Test Reports
      • Lab Test Report List
      • Create a Lab Test Report
      • Update Lab Test Report
      • Delete a Lab Test Report
    • Wellness Plans
      • Create a Supplement Plan for Member
      • Update Member Supplement
      • List Member Supplement Plans
      • Delete Member Supplement Plan
Powered by GitBook
On this page
  • Required Argument
  • Available fields
  • Examples
  1. API Reference
  2. Members

Member List

PreviousMembersNextMembers List

Last updated 3 years ago

Use the member query to list the information of a specific by a given ID.

Required Argument

Required Name
Type
Description

Required Name

Type

Description

id

ID

Available fields

Field name

Type

Description

name

String

Member name

birthdate

Date

Member birthdate

phone

String

Member's phone

memberSince

Date

Date when the member has joined the TeleWellness Portal.

biologicalSex

biologicalSex

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

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)

startingWeight

Float

The user's current weight. Expressed in kilograms.

targetWeight

Float

The user's target weight. Expressed in kilograms.

weeklyWeightGoal

WeeklyWeightGoal

User weekly weight-related goal. Valid values are:

MANTAIN: maintain the weight,

GOAL_1: lose 0.5 lb,

GOAL_2: lose (1 lb),

GOAL_3: lose (1.5 lb),

GOAL_4: lose (4 lb)

goalsOn

Boolean

True if the goals functionality is enabled. Requires all other parameters to be set.

lastLogin

DateTime

Date of the member's last login

program

Object that returns the program information assigned to the member

restrictions

Object that returns the information of the restrictions applied to the member

Examples

query {
  member(id: "TWVtYmVyOjBhMTA3YWM5LTg4Y2EtNGJkYy1iOTdhLWIyODE4NDA1ODVjZA==") {
   id
    name
    birthdate
    memberSince
    weight
    height
    credits {
      id
      value
    }

    program {
      id
      name
      slug
      author
      image
      cover
      backgroundImage
      descriptionShort
      descriptionLong
      restrictions {
        id
        name
        slug
      }
    }
  }
}
{
  "data": {
    "member": {
      "id": "TWVtYmVyOjBhMTA3YWM5LTg4Y2EtNGJkYy1iOTdhLWIyODE4NDA1ODVjZA==",
      "name": "Liliana Iriarte S.",
      "birthdate": "1993-01-25",
      "memberSince": "2021-12-29",
      "weight": null,
      "height": 1.651,
      "credits": [
        {
          "id": "QXBwb2ludG1lbnRDcmVkaXQ6Mg==",
          "value": 1
        }
      ],
      "program": {
        "id": "UHJvZ3JhbTo0NDIzYTgwNy0wNGFiLTQwOGItODk1Mi00YWU5NzA5NmQ2YjQ=",
        "name": "Weight and Wellness",
        "slug": "weight-and-wellness",
        "author": "SuggesticPlus",
        "image": null,
        "cover": "https://sg-data.storage.googleapis.com/images_bucket/cover_weight-and-wellness_uhc-b692cc63-8e33-4d53-95e4-356b6ac857e2.png",
        "backgroundImage": "program/weight-and-wellness.png",
        "descriptionShort": "The Mediterranean Dietary Pattern is similar to the Healthy Dietary Pattern; however, it contains more fruit and seafood and less dairy.",
        "descriptionLong": "The Mediterranean Dietary Pattern is similar to the Healthy Dietary Pattern; however, it contains more fruit and seafood and less dairy.\r\n\r\nThis program adheres to a \"Healthy Dietary Pattern\" which includes nutrient-dense vegetables, fruits, grains, dairy, protein, and oils. It limits added sugars, saturated and trans fats, and sodium. Nutrient-dense foods are those that are in their lowest fat form, with little or no saturated fat, and contain little or no added salt or sugar.",
        "restrictions": []
      }
    }
  }
}

Unique member ID. Get this ID by executing the query.

member
member
program
restrictions