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

Authentication Scopes

A list of supported auth scopes for token generation.

PreviousReferenceNextErrors and Troubleshooting

Last updated 4 years ago

Was this helpful?

Scope

Description

Supported API Services

community.read

This scope provides you the ability to read a community's data.

community.write

This scope provides you the ability to edit community's data.

  • Add recipes to a community.

  • Remove a recipe from a community.

cookbook:read

This scope provides you the ability to read recipes, recipe collections, and custom labels data.

  • Get a list of all custom labels created by the current user.

cookbook:write

This scope provides you the ability to edit data of recipes and recipe collections.

  • Update a recipe collection.

  • Add a recipe to multiple recipe collections.

food_list:read

This scope provides you the ability to read food list data.

Get a food list.

food_list:write

This scope provides you the ability to edit food list data.

  • Add an item to a food list.

  • Update an item in a food list.

  • Delete an item from a food list.

shopping_list:read

This scope provides you the ability to read shopping list data.

  • Get a list of all shopping lists of a user.

shopping_list:write

This scope provides you the ability to edit shopping list data.

  • Move items from one shopping list to another.

  • Clear items from a shopping list.

  • Delete an item from a shopping list.

  • Update an item in a shopping list.

meal_plan:read

This scope provides you the ability to read meal plan data.

meal_plan:write

This scope provides you the ability to edit meal plan data.

  • Update a meal in a meal plan.

  • Get a batch of meals.

  • Modify a batch of meals.

storeitem:read

This scope provides you the ability to read a particular store items' data.

Get store items.

user.profile:read

This scope provides you the ability to read a user profile's data.

user.profile:write

This scope provides you the ability to edit a user profile's data.

Create a shopping list.
Delete a shopping list.
Edit a shopping list.
Add items to a shopping list.
Get your communities.
Get communities from a topic.
Discover recommended communities.
Search communities.
Get details of a specific community.
Get a recipes from a community.
Get a list of user's recipes.
Get a recipe by ID or URL.
Search recipes.
Get a list of user's recipe collections.
Get a specific recipe collection.
Get a list of recipes from a specific recipe collection.
Create or update a recipe.
Update an external recipe.
Create a recipe collection.
Delete a specific recipe collection.
Delete a recipe from a specific recipe collection.
Get a shopping list.
Get meals for a specific period from a meal plan.
Get meal plan settings.
Generate a meal plan for a specific period.
Clear meals for a specific duration from a particular meal plan.
Add a meal to a meal plan.
Remove a meal from a meal plan.
Update meal plan settings.
Get details of a user.
Update details of a user.