# Whisk Docs

## v2.0.0

- [The Whisk Platform](/readme.md): Introducing the Whisk Platform.
- [Introduction](/api-overview/introduction.md): Learn how to integrate Whisk to power your food applications using our REST API.
- [Integration](/api-overview/whisk-api-integration.md): Learn how to integrate with the Whisk.
- [Authentication](/api-overview/auth.md): Learn how to authenticate the use of Whisk API services.
- [Server Token](/api-overview/auth/server-token.md): A server token allows you to enable server-to-server integration with Whisk for non-personalized data.
- [User Access Token](/api-overview/auth/user-access-token.md): A user access token authorizes you to read, modify or write data on behalf of a specific Whisk user.
- [Auth Flow Example](/api-overview/auth/user-access-token/auth-flow-example.md): Learn about the Whisk authentication flow.
- [Client Token](/api-overview/auth/client-token.md): A client token allows you to access a limited subset of Whisk APIs in read-only mode.
- [Anonymous Access from Client Apps](/api-overview/auth/anonymous-access-from-client-apps.md)
- [Whisk Sandbox](/api-overview/whisk-sandbox.md): Whisk Sandbox allows risk and cost free testing of our API services.
- [Getting Started](/api-overview/quick-start-guide.md)
- [Provisioning](/api/provisioning.md)
- [Get provisioning](/api/provisioning/get-provisioning.md): Endpoint allows to get provisioning data
- [Autocomplete](/api/autocomplete.md): The Autocomplete endpoint allows you to guess a product a user is writing into an input field. It then may be displayed as a shopping list or search suggestion.
- [Community](/api/community.md): The Community API service offers you the ability to discover, search, and retrieve communities related to recipe content that exist on Whisk.
- [Get your Communities](/api/community/get-your-communities.md): This endpoint retrieves a list of communities filtered by your role and pagination.
- [Get Communities from a Topic](/api/community/get-communities-by-topic.md): This endpoint retrieves the list of communities from a specific topic using the topic identifier and pagination filters.
- [Discover Recommended Communities](/api/community/discover-recommended-communities.md): This endpoint retrieves a list of communities recommended to you by Whisk.
- [Search Communities](/api/community/search-communities.md): This endpoint allows you to search for communities using keywords and various filters.
- [Get a Community](/api/community/get-a-community.md): This endpoint retrieves community details using the community identifier.
- [Get Recipes from a Community](/api/community/get-recipes-from-a-community.md): This endpoint retrieves a list of recipes from a specific community using the community identifier and pagination filters.
- [Add Recipes to a Community](/api/community/add-recipes-to-a-community.md): This endpoint allows you add a batch of existing recipes in a community.
- [Remove a Recipe from a Community](/api/community/remove-a-recipe-from-a-community.md): This endpoint allows you to remove a recipe from a community.
- [Join a Community](/api/community/join-a-community.md): This endpoint allows to become a member of a public community.
- [Leave a Community](/api/community/leave-a-community.md): This endpoint allows to leave a community.
- [Posts and Reviews](/api/posts-and-reviews.md): Posts and reviews API allows to support social functions in your App, like writing reviews for recipes , add Posts (with different types attached content), leave replies.
- [Get reviews for a recipe](/api/posts-and-reviews/get-reviews-for-a-recipe.md): API endpoint allows you to get reviews for particular recipe
- [Create or edit review](/api/posts-and-reviews/create-or-edit-review.md): Endpoint allows to create new review or edit existing review
- [Create a Post](/api/posts-and-reviews/create-a-post.md): Endpoint allows to create new Post
- [Get Post by id](/api/posts-and-reviews/get-post-by-id.md): Endpoint allows to get Post by Id
- [Delete a Post](/api/posts-and-reviews/delete-a-post.md): Endpoint allows to delete a post
- [Edit a Post](/api/posts-and-reviews/edit-a-post.md): Endpoint allows to create new Post
- [Report a Post](/api/posts-and-reviews/report-a-post.md): Endpoint allows to report a post
- [Create a Post Reply](/api/posts-and-reviews/create-a-post-reply.md): Endpoint allows to create new Reply
- [Get Post Replies](/api/posts-and-reviews/get-post-replies.md): Endpoint allows to get Reply by Id
- [Delete a Post reply](/api/posts-and-reviews/delete-a-post-reply.md): Endpoint allows to delete a reply
- [Report a Post reply](/api/posts-and-reviews/report-a-post-reply.md): Endpoint allows to report post reply
- [Like a Post or Reply](/api/posts-and-reviews/like-a-post-or-reply.md): Endpoint allows to like existing post or Reply
- [Users who liked a Post or Reply](/api/posts-and-reviews/users-who-liked-a-post-or-reply.md): Endpoint allows to get users who liked existing post or Reply
- [Public profiles](/api/public-profiles.md): Posts and reviews API allows to support social functions in your App, like writing reviews for recipes , add Posts (with different types attached content), leave replies.
- [Hide recipe in Public profile](/api/public-profiles/hide-recipe-in-public-profile.md): Endpoint allows user who don't want to show recipe in public profile to hide it. Recipe will remain in his recipe box (favourites)
- [Get Recipes for Public Profile](/api/public-profiles/get-recipes-from-a-collection.md): There are recipes displayed in public profile, based on several conditions. Endpoint allows to get recipes available in public profile.
- [Get User's public profile by user\_id](/api/public-profiles/get-users-public-profile-by-user_id.md): Endpoint allows to get user's public profile by Id
- [Get User's public profile by username](/api/public-profiles/get-users-public-profile-by-username.md): Endpoint allows to get user's public profile by Username
- [Custom Label](/api/custom-label.md): Custom labels are user-defined labels added to recipes.
- [Feed](/api/feed.md)
- [Obtain a Recipe Feed](/api/feed/recipe-feed.md)
- [Food DB](/api/food-db.md)
- [Autocomplete](/api/food-db/autocomplete.md): GET https://api.whisk.com/food/v2/autocomplete
- [Search](/api/food-db/search.md): POST https://api.whisk.com/food/v2/search
- [Get Food](/api/food-db/get-food.md): GET https://api.whisk.com/food/v2/get
- [Food List](/api/food-list.md)
- [Food Log](/api/food-log.md): Food logging is often used in pair with Healthy recipe recommendations
- [Foodpairing](/api/foodpairing.md)
- [Healthy meal recommendations](/api/healthy-meal-recommendations.md)
- [Healthy recipe only recommendations for DA](/api/healthy-meal-recommendations/healthy-recipe-only-recommendations-for-da.md)
- [Recipe recommendations for SH](/api/healthy-meal-recommendations/healthy-recipe-only-recommendations-for-sh.md): A method to fetch a set of recipes supporting a certain calorie goal
- [Tailored Plan API request for Samsung TV](/api/healthy-meal-recommendations/tailored-plan-api-request-for-samsung-tv.md)
- [Meal Plan](/api/meal-plans.md)
- [Generate a Meal Plan](/api/meal-plans/generate_mealplan.md)
- [Meal Object](/api/meal-plans/meal.md)
- [Get Meals](/api/meal-plans/meal/meal-plan-management.md): A method to get a meal.
- [Delete Meal](/api/meal-plans/meal/delete-meals.md): A method to delete a meal from a meal plan.
- [Add a Meal](/api/meal-plans/meal/update-meal.md): A method to add a meal to a meal plan.
- [Meal Plan Settings Object](/api/meal-plans/get-meal-plan-settings.md): The meal plan settings object
- [Get Meal Plan Settings](/api/meal-plans/get-meal-plan-settings/get-meal-plan-settings.md)
- [Update Meal Plan Settings](/api/meal-plans/get-meal-plan-settings/update-meal-plan-settings.md)
- [Meal Plan Batch](/api/meal-plans/meal-plan-batch.md)
- [Recipe](/api/recipes.md): The Recipe API service lets you read and write any internal and external recipes and your Whisk recipe collections.
- [Get a Recipe](/api/recipes/get-recipe-nutrition.md)
- [Search a Recipe](/api/recipes/recipe-search.md): A method to search recipes.
- [User Recipes & Collections](/api/recipes/user-recipes-and-collections.md)
- [Add User Recipe](/api/recipes/user-recipes-and-collections/add-user-recipe.md)
- [Create A Recipe](/api/recipes/user-recipes-and-collections/create-a-recipe.md)
- [Update External Recipe](/api/recipes/user-recipes-and-collections/updaterecipe.md)
- [Get All User Recipes](/api/recipes/user-recipes-and-collections/get-all-user-recipes.md)
- [Update User Recipe](/api/recipes/user-recipes-and-collections/update-user-recipe.md)
- [Remove Recipe from Favorites](/api/recipes/user-recipes-and-collections/remove-recipe-from-favorites.md)
- [Create Collection](/api/recipes/user-recipes-and-collections/create-collection.md)
- [Get All User Collections](/api/recipes/user-recipes-and-collections/get-all-user-collections.md)
- [Get Collection](/api/recipes/user-recipes-and-collections/get-collection.md)
- [Get Recipes from a Collection](/api/recipes/user-recipes-and-collections/get-recipes-from-a-collection.md)
- [Remove Collection](/api/recipes/user-recipes-and-collections/remove-collection.md)
- [Get Smart Collection](/api/recipes/user-recipes-and-collections/get-collection-1.md): Method for getting smart collections. Smart collections are special types of collections created automatically in Whisk. Content in smart collections also updates automatically based on user actions.
- [Get Recipes from a Smart Collection](/api/recipes/user-recipes-and-collections/get-recipes-from-a-collection-1.md): Method allow to get all recipes in Smart collection
- [Shopping List](/api/shopping-lists.md): The Shopping List API service offers you the ability to read and write your shopping list data.
- [Get your Shopping Lists](/api/shopping-lists/get-shopping-lists.md): This endpoint offers you the ability to read reference details of all your shopping lists that exist in your Whisk account.
- [Get a Shopping List](/api/shopping-lists/get-a-shopping-list.md): This endpoint allows you to read data of a shopping list.
- [Create a Shopping List](/api/shopping-lists/create-a-shopping-list.md): This endpoint allows you create a new shopping list.
- [Delete a Shopping List](/api/shopping-lists/delete-a-shopping-list.md): This endpoint allows you to delete any secondary shopping list.
- [Update basic details of a Shopping List](/api/shopping-lists/update-basic-details-of-a-shopping-list.md): This endpoint allows you to update the shopping list name or set/reset it as primary.
- [Move Items between Shopping Lists](/api/shopping-lists/move-items-between-shopping-lists.md): This endpoints allows you to move shopping list items from one shopping list to another.
- [Add Items to a Shopping List](/api/shopping-lists/add-items-to-a-shopping-list-1.md): This endpoints allows you to add items to your shopping list.
- [Delete an Item from a Shopping List](/api/shopping-lists/delete-an-item-from-a-shopping-list.md): This endpoint allows you remove an item from a shopping list.
- [Update an Item in a Shopping List](/api/shopping-lists/update-an-item-in-a-shopping-list.md): This endpoint allows you update an item in a shopping list.
- [Clear Items from a Shopping List](/api/shopping-lists/clear-items-from-a-shopping-list.md): This endpoint allows you to remove items from a shopping list.
- [Media](/api/media.md): Media service API allow to upload images into the whisk cloud. Maximum image size is 50M
- [Store Item](/api/store-item.md)
- [Unit Conversion](/api/unit-conversion.md)
- [Users](/api/user-model.md)
- [Get a User](/api/user-model/get-a-user.md)
- [Update User Settings using Patch](/api/user-model/update-a-user.md)
- [Update User Settings using Post](/api/user-model/user-profile.md)
- [Overview](/shopping-list-sdk/overview.md)
- [Examples](/shopping-list-sdk/examples.md)
- [Shoppable Recipes](/shopping-list-sdk/examples/shoppable-recipes.md)
- [Shoppable Products](/shopping-list-sdk/examples/shoppable-products.md)
- [Shoppable Media](/shopping-list-sdk/examples/shoppable-media.md)
- [Basic Setup](/shopping-list-sdk/basic-setup.md)
- [Basic Setup](/shopping-list-sdk/basic-setup/basic-setup.md)
- [Methods](/shopping-list-sdk/basic-setup/methods.md)
- [Event Listeners](/shopping-list-sdk/basic-setup/event-listeners.md)
- [Widget](/shopping-list-sdk/basic-setup/widget.md)
- [Subscriptions](/shopping-list-sdk/basic-setup/subscriptions.md)
- [Global Configuration](/shopping-list-sdk/basic-setup/global-configuration.md)
- [UTM Parameters](/shopping-list-sdk/basic-setup/utm-parameters.md)
- [Using With SPA](/shopping-list-sdk/basic-setup/using-with-spa.md)
- [Overview](/shopping-list-mobile-api/overview.md)
- [Examples](/shopping-list-mobile-api/examples.md)
- [Reference](/shopping-list-mobile-api/reference.md)
- [Authentication Scopes](/resources/authentication-scopes.md): A list of supported auth scopes for token generation.
- [Errors and Troubleshooting](/resources/error-handling.md): All supported errors that you may unfortunately encounter while using Whisk API.
- [Cursor Pagination](/resources/cursor-pagination.md)
- [Limits](/resources/limits.md)
- [Nutrients](/resources/nutrients.md): Nutrition calculations, Macronutrients, and Micronutrients.
- [Recipe Labels](/resources/recipe-labels.md)
- [Filtering Recipes using Custom Labels](/resources/custom-labels.md): This topic comprehensively describes how you can use the Custom Labels filter to search recipes.
- [Health Score, Glycemic Index, Glycemic Load](/resources/health-score-glycemic-index-glycemic-load.md)
- [Whisk User Data](/resources/whisk-user-data.md)
- [Integrated Retailers](/resources/supported-retailers.md): List of retailers that are integrated with Whisk.
- [Optimizing Image Load](/resources/optimizing-image-load.md)
- [Meal Plan](/resources/meal-plan.md)

## v1.0.0

- [Overview](/master/master.md)
- [Creating An Account](/master/guides/creating-an-account.md)
- [Getting Started](/master/guides/quick-start-guide.md)
- [Whisk Sandbox](/master/guides/whisk-sandbox.md)
- [Authentication](/master/api/auth.md)
- [Server Token](/master/api/auth/server-token.md)
- [Client Token](/master/api/auth/client-token.md)
- [User Access Token](/master/api/auth/user-access-token.md)
- [Anonymous Access](/master/api/auth/anonymous-access.md)
- [Recipes](/master/api/recipes.md)
- [Get Recipe](/master/api/recipes/get-recipe-nutrition.md)
- [Get Recipe Categories](/master/api/recipes/recipe-categories.md)
- [Recipe Objects](/master/api/recipes/recipe-objects.md)
- [Recipe Discovery](/master/api/recipe-discovery.md)
- [Recipe Feed](/master/api/recipe-discovery/recipe-feed.md)
- [Recipe Search](/master/api/recipe-discovery/recipe-search.md)
- [Get Similar Recipes](/master/api/recipe-discovery/get-similar-recipes.md)
- [Shopping Lists](/master/api/shopping-lists.md)
- [Get Shopping Lists](/master/api/shopping-lists/get-shopping-lists.md)
- [Create A Shopping List](/master/api/shopping-lists/create-a-shopping-list.md)
- [Add Items To A Shopping List](/master/api/shopping-lists/add-items-to-a-shopping-list.md)
- [List Analysis](/master/api/shopping-lists/list-analysis.md)
- [Meal Plans](/master/api/meal-plans.md)
- [Meal Plan Management](/master/api/meal-plans/meal-plan-management.md)
- [Delete Meals](/master/api/meal-plans/delete-meals.md)
- [Auto-Generator](/master/api/meal-plans/auto-generator.md)
- [Error Handling](/master/api/meal-plans/error-handling.md)
- [Retailers](/master/api/retailers.md)
- [Get Available Stores](/master/api/retailers/get-available-stores.md)
- [Retailers Checkout Flow](/master/api/retailers/retailers-checkout-flow.md)
- [Retailer Aliases](/master/api/retailers/retailers-aliases.md)
- [OAuth Retailer Flow](/master/api/retailers/oauth-retailer-flow.md)
- [Retailer User Info](/master/api/retailers/retailer-user-info.md)
- [Search Store Items](/master/api/retailers/search-store-items.md)
- [Carts](/master/api/carts.md)
- [Create a Cart](/master/api/carts/create-a-cart.md)
- [Update Cart Item](/master/api/carts/update-cart-item.md)
- [Splitting Combined Items](/master/api/carts/split-combined-items.md)
- [Add Items To Cart](/master/api/carts/add-items-to-cart.md)
- [Add Recipes To Cart](/master/api/carts/add-recipes-to-cart.md)
- [Get Cart Item Options](/master/api/carts/get-cart-item-options.md)
- [Swap Cart Item Product](/master/api/carts/swap-cart-item-product.md)
- [Delete A Cart Or A Cart Item](/master/api/carts/delete-a-cart-or-a-cart-item.md)
- [Checkout](/master/api/carts/checkout.md)
- [Users](/master/api/user-model.md)
- [Get A User](/master/api/user-model/get-a-user.md)
- [Update A User](/master/api/user-model/update-a-user.md)
- [User Recipes & Collections](/master/api/user-recipes-and-collections.md)
- [Add User Recipe](/master/api/user-recipes-and-collections/add-user-recipe.md)
- [Create A Recipe](/master/api/user-recipes-and-collections/create-a-recipe.md)
- [Update External Recipe](/master/api/user-recipes-and-collections/updaterecipe.md)
- [Get All User Recipes](/master/api/user-recipes-and-collections/get-all-user-recipes.md)
- [Update User Recipe](/master/api/user-recipes-and-collections/update-user-recipe.md)
- [Remove Recipe from Favorites](/master/api/user-recipes-and-collections/remove-recipe-from-favorites.md)
- [Create Collection](/master/api/user-recipes-and-collections/create-collection.md)
- [Get All User Collections](/master/api/user-recipes-and-collections/get-all-user-collections.md)
- [Get Collection](/master/api/user-recipes-and-collections/get-collection.md)
- [Get Recipes from a Collection](/master/api/user-recipes-and-collections/get-recipes-from-a-collection.md)
- [Remove Collection](/master/api/user-recipes-and-collections/remove-collection.md)
- [Tools](/master/api/tools.md)
- [Autocomplete](/master/api/tools/autocomplete.md)
- [Overview](/master/shopping-list-sdk/overview.md)
- [Examples](/master/shopping-list-sdk/examples.md)
- [Shoppable Recipes](/master/shopping-list-sdk/examples/shoppable-recipes.md)
- [Shoppable Products](/master/shopping-list-sdk/examples/shoppable-products.md)
- [Shoppable Media](/master/shopping-list-sdk/examples/shoppable-media.md)
- [Basic Setup](/master/shopping-list-sdk/basic-setup.md)
- [Basic Setup](/master/shopping-list-sdk/basic-setup/basic-setup.md)
- [Methods](/master/shopping-list-sdk/basic-setup/methods.md)
- [Event Listeners](/master/shopping-list-sdk/basic-setup/event-listeners.md)
- [Widget](/master/shopping-list-sdk/basic-setup/widget.md)
- [Subscriptions](/master/shopping-list-sdk/basic-setup/subscriptions.md)
- [Global Configuration](/master/shopping-list-sdk/basic-setup/global-configuration.md)
- [UTM Parameters](/master/shopping-list-sdk/basic-setup/utm-parameters.md)
- [Using With SPA](/master/shopping-list-sdk/basic-setup/using-with-spa.md)
- [Overview](/master/shopping-list-mobile-api/overview.md)
- [Examples](/master/shopping-list-mobile-api/examples.md)
- [Reference](/master/shopping-list-mobile-api/reference.md)
- [Object IDs](/master/tips/object-ids.md)
- [URL Lookup](/master/tips/url-lookup.md)
- [Searching](/master/tips/searching.md)
- [Multiple IDs request](/master/tips/multiple-ids-request.md)
- [Nutrients](/master/resources/nutrients.md)
- [Recipe Labels](/master/resources/recipe-labels.md)
- [Health Score, Glycemic Index, Glycemic Load](/master/resources/health-score-glycemic-index-glycemic-load.md)
- [Whisk User Data](/master/resources/whisk-user-data.md)
- [Supported Retailers](/master/resources/supported-retailers.md)
- [Optimizing Image Load](/master/resources/optimizing-image-load.md)