Whisk Docs
Whisk HomeHelp CenterDeveloper Tools
v1.0.0
v1.0.0
  • Overview
  • Guides
    • Creating An Account
    • Getting Started
    • Whisk Sandbox
  • API
    • Authentication
      • Server Token
      • Client Token
      • User Access Token
      • Anonymous Access
    • Recipes
      • Get Recipe
      • Get Recipe Categories
      • Recipe Objects
    • Recipe Discovery
      • Recipe Feed
      • Recipe Search
      • Get Similar Recipes
    • Shopping Lists
      • Get Shopping Lists
      • Create A Shopping List
      • Add Items To A Shopping List
      • List Analysis
    • Meal Plans
      • Meal Plan Management
      • Delete Meals
      • Auto-Generator
      • Error Handling
    • Retailers
      • Get Available Stores
      • Retailers Checkout Flow
      • Retailer Aliases
      • OAuth Retailer Flow
      • Retailer User Info
      • Search Store Items
    • Carts
      • Create a Cart
      • Update Cart Item
      • Splitting Combined Items
      • Add Items To Cart
      • Add Recipes To Cart
      • Get Cart Item Options
      • Swap Cart Item Product
      • Delete A Cart Or A Cart Item
      • Checkout
    • Users
      • Get A User
      • Update A User
    • 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
    • Tools
      • Autocomplete
  • 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
  • Tips and Tricks
    • Object IDs
    • URL Lookup
    • Searching
    • Multiple IDs request
  • Resources
    • Nutrients
    • Recipe Labels
    • Health Score, Glycemic Index, Glycemic Load
    • Whisk User Data
    • Supported Retailers
    • Optimizing Image Load
Powered by GitBook
On this page
  • Get Recipe Categories
  • Sample Request
  • Response
  • RecipeCategory
  • Paging
  • Cursors

Was this helpful?

  1. API
  2. Recipes

Get Recipe Categories

This endpoint allows getting all available categories for a specific language.

Get Recipe Categories

POST https://graph.whisk.com/v1/recipes/categories

Path Parameters

Name
Type
Description

country

string

Country ISO code. Default is gb

limit

number

Number of categories

{
  "categories": [
    {
      "id": "quick-and-easy",
      "displayName": "Quick and easy",
      "image": {
        "url": "https://whisk-res.cloudinary.com/image/upload/v1523894700/custom_upload/ba4d7363cd46c736675d2cc08754f5bc.png",
        "width": 800,
        "height": 800
      }
    },
    {
      "id": "healthy-recipes",
      "displayName": "Healthy Recipes",
      "image": {
        "url": "https://whisk-res.cloudinary.com/image/upload/v1523894700/custom_upload/ba4d7363cd46c736675d2cc08754f5bc.png",
        "width": 800,
        "height": 800
      }
    },
    {
      "id": "holidays-and-events",
      "displayName": "Holidays and Events",
      "image": {
        "url": "https://whisk-res.cloudinary.com/image/upload/v1523894700/custom_upload/ba4d7363cd46c736675d2cc08754f5bc.png",
        "width": 800,
        "height": 800
      }
    },
    {
      "id": "baking",
      "displayName": "Baking",
      "image": {
        "url": "https://whisk-res.cloudinary.com/image/upload/v1523894700/custom_upload/ba4d7363cd46c736675d2cc08754f5bc.png",
        "width": 800,
        "height": 800
      }
    },
    {
      "id": "bbq-and-grilling",
      "displayName": "BBQ & Grilling",
      "image": {
        "url": "https://whisk-res.cloudinary.com/image/upload/v1523894700/custom_upload/ba4d7363cd46c736675d2cc08754f5bc.png",
        "width": 800,
        "height": 800
      }
    }
  ],
  "paging": {
    "cursors": {
      "after": "eyJpZCI6ImRlc3NlcnRzIiwiaW5kZXgiOjR9"
    }
  }
}

Sample Request

curl "https://graph.whisk.com/v1/recipes/categories?country=gb&limit=5" \
    -H "Accept: application/json" \
    -H "Authorization: Token <Access-Token>"

Response

ATTRIBUTE

TYPE

DESCRIPTION

categories*

paging

RecipeCategory

ATTRIBUTE

TYPE

DESCRIPTION

id*

string

displayName*

string

image

ResponsiveImage

Paging

ATTRIBUTE

TYPE

DESCRIPTION

cursors*

Cursors

ATTRIBUTE

TYPE

DESCRIPTION

after

string

before

string

PreviousGet RecipeNextRecipe Objects

Last updated 4 years ago

Was this helpful?

The result is a list of all available categories corresponding to the required region. You can use these categories for filtering recipes in .

array []

search
RecipeCategory
Paging
Cursors