Whisk Docs
Whisk HomeHelp CenterDeveloper Tools
v2.0.0
v2.0.0
  • The Whisk Platform
  • Whisk API Overview
    • Introduction
    • Integration
    • Authentication
      • Server Token
      • User Access Token
        • Auth Flow Example
      • Client Token
      • Anonymous Access from Client Apps
    • Whisk Sandbox
    • Getting Started
  • Whisk API Reference 2.0
    • Provisioning
      • Get provisioning
    • Autocomplete
    • Community
      • Get your Communities
      • Get Communities from a Topic
      • Discover Recommended Communities
      • Search Communities
      • Get a Community
      • Get Recipes from a Community
      • Add Recipes to a Community
      • Remove a Recipe from a Community
      • Join a Community
      • Leave a Community
    • Posts and Reviews
      • Get reviews for a recipe
      • Create or edit review
      • Create a Post
      • Get Post by id
      • Delete a Post
      • Edit a Post
      • Report a Post
      • Create a Post Reply
      • Get Post Replies
      • Delete a Post reply
      • Report a Post reply
      • Like a Post or Reply
      • Users who liked a Post or Reply
    • Public profiles
      • Hide recipe in Public profile
      • Get Recipes for Public Profile
      • Get User's public profile by user_id
      • Get User's public profile by username
    • Custom Label
    • Feed
      • Obtain a Recipe Feed
    • Food DB
      • Autocomplete
      • Search
      • Get Food
    • Food List
    • Food Log
    • Foodpairing
    • Healthy meal recommendations
      • Healthy recipe only recommendations for DA
      • Recipe recommendations for SH
      • Tailored Plan API request for Samsung TV
    • Meal Plan
      • Generate a Meal Plan
      • Meal Object
        • Get Meals
        • Delete Meal
        • Add a Meal
      • Meal Plan Settings Object
        • Get Meal Plan Settings
        • Update Meal Plan Settings
      • Meal Plan Batch
    • Recipe
      • Get a Recipe
      • Search a Recipe
      • User Recipes & Collections
        • Add User Recipe
        • Create A Recipe
        • Update External Recipe
        • Get All User Recipes
        • Update User Recipe
        • Remove Recipe from Favorites
        • Create Collection
        • Get All User Collections
        • Get Collection
        • Get Recipes from a Collection
        • Remove Collection
        • Get Smart Collection
        • Get Recipes from a Smart Collection
    • Shopping List
      • Get your Shopping Lists
      • Get a Shopping List
      • Create a Shopping List
      • Delete a Shopping List
      • Update basic details of a Shopping List
      • Move Items between Shopping Lists
      • Add Items to a Shopping List
      • Delete an Item from a Shopping List
      • Update an Item in a Shopping List
      • Clear Items from a Shopping List
    • Media
    • Store Item
    • Unit Conversion
    • Users
      • Get a User
      • Update User Settings using Patch
      • Update User Settings using Post
    • Try it out!
  • Shopping List SDK
    • Overview
    • Examples
      • Shoppable Recipes
      • Shoppable Products
      • Shoppable Media
    • Basic Setup
      • Basic Setup
      • Methods
      • Event Listeners
      • Widget
      • Subscriptions
      • Global Configuration
      • UTM Parameters
      • Using With SPA
  • Shopping List Mobile API
    • Overview
    • Examples
    • Reference
  • API Resources
    • Authentication Scopes
    • Errors and Troubleshooting
    • Cursor Pagination
    • Limits
    • Nutrients
    • Recipe Labels
    • Filtering Recipes using Custom Labels
    • Health Score, Glycemic Index, Glycemic Load
    • Whisk User Data
    • Integrated Retailers
    • Optimizing Image Load
    • Meal Plan
Powered by GitBook
On this page

Was this helpful?

  1. API Resources

Whisk User Data

Whisk stores the following user data for every user:

NAME

DESCRIPTION

First Name

The user’s first name

Last Name

The user’s last name

Display Name

The user’s display name inside Whisk

Email

The user’s email address - used for sign up and sign in

Phone number

The user’s personal phone number - used for sign up and sign in

Password

The user’s account password

Created At

The time and date when the user was created

Updated At

The time and date when the user was last updated

Photo

A link to the user’s uploaded image used as the account’s avatar

Language

Location (Country)

Location (Zip code)

The user’s location by zip code

Age

The user’s age

Weight

The user’s weight (imperial / metric)

Height

The user’s height (imperial / metric)

Gender

The user’s sex: male / female / unspecified

Activity Level

The user’s physical activity level: very light / light / moderate / active / very active

Diets

Avoidances

Preferred Ingredients

A list of the user’s preferred ingredients

Disliked Ingredients

A list of the user’s disliked ingredients

Organic / non organic

The user can set his preferences for organic or non-organic products

Nutrition preferences

A list of nutrition labels preferred by user (Healthy, Low carbs, Low calories, Low fat, Low sugar, High Fiber, Low Salt, High Protein or None)

Health Habits & Goals

User defined health goals: eat more plant-based / limit sugars / eat more whole-grain breads and cereals / eat more fiber / choose healthy fats / eat more nuts and seeds / slow carb instead of no carb / weight loss / weight gain)

Household size - number of children

The number of children of the user’s household

Household size - number of adults

The number of adults of the user’s household

Favorite cuisines

A list of the user’s favorite cuisines: african / american / asian / australian / brilian / japanese / korean / latin-american / mediterranean / mexican / middle-eastern / moroccan / portuguese / southern / spanish / tex-mex / thai/ vietnamese / world-cuisine

Devices, Appliances & Utensils

A list of cooking appliances the user is cooking with: mixer / slow cooker / instant pot / joule sous vide / stove / oven / air fryer

Cooking Experience

The user’s cooking skill: amateur / intermediate / advanced

Cooking Time

The user preferable time for cooking: 15 min or less / 30 min or less / 60 min or less / unlimited

Preferred Retailer

Budget Goals

The user’s budget preferences: budget friendly / average price / premium

Ethical Preferences

The user’s ethical cooking preferences: low waste products / environmental effect

PreviousHealth Score, Glycemic Index, Glycemic LoadNextIntegrated Retailers

Last updated 5 years ago

Was this helpful?

The user’s preferable language in format

The user’s location by country code (as listed on )

A list of diet the user may follow from

A list of the user’s avoidances - allergies and intolerances from

The user’s preferred retailer for grocery shopping:

available retailers list here
ISO 639-1
ISO 3166-1 alpha-2
this list of diets
this list of avoidances