Get Recipes from a Smart Collection

Method allow to get all recipes in Smart collection

This endpoint allows getting all recipes from a smart collection.

Get Recipes from Smart Collection

GET https://api.whisk.com/v2/smart_collection/{collection_id}/recipes

Method allows to get smart collection content and to mention which recipes fields to get

Path Parameters

NameTypeDescription

collection_id*

string

Unique smart collection identifier

Query Parameters

NameTypeDescription

paging.limit

number

Number of replies to get on a page

paging.cursors.before

string

This parameter is used for cursor-based pagination.

paging.cursors.after

string

This parameter is used for cursor-based pagination.

fields

array[string]

Fields. Available values : RECIPE_FIELD_INVALID, RECIPE_FIELD_NORMALIZED_INGREDIENTS, RECIPE_FIELD_INSTRUCTIONS, RECIPE_FIELD_INSTRUCTION_INTENTS, RECIPE_FIELD_NUTRITION, RECIPE_FIELD_NUTRITION_COVERAGE, RECIPE_FIELD_SAVED, RECIPE_FIELD_INGREDIENTS_LINKED_PRODUCTS, RECIPE_FIELD_SAVE_COUNT, RECIPE_FIELD_NORMALIZED_INGREDIENT_NUTRITION, RECIPE_FIELD_AVAILABILITY, RECIPE_FIELD_CONTENT_POLICY_VIOLATION, RECIPE_FIELD_AUTHOR, RECIPE_FIELD_PARENT, RECIPE_FIELD_REVIEWS_STATS, RECIPE_FIELD_REVIEWS_TAGS, RECIPE_FIELD_MY_REVIEW

smart_tags

array[string]

Smart tags for recently viewed collection

Headers

NameTypeDescription

Authorization*

String

User Access token to authorize the API usage. For more information, see Authentication

{
  "recipes": [
    {
      "recipe": {
        "id": "string",
        "name": "string",
        "description": "string",
        "ingredients": [
          {
            "text": "string",
            "group": "string",
            "linked_products": [
              {
                "id": "string",
                "name": "string",
                "images": [
                  {
                    "responsive": {
                      "url": "string",
                      "width": 0,
                      "height": 0,
                      "selection": {
                        "x": 0,
                        "y": 0,
                        "width": 0,
                        "height": 0
                      }
                    },
                    "url": "string"
                  }
                ],
                "description": "string",
                "url": "string",
                "price": {
                  "rrp": {
                    "currency_code": "string",
                    "cents": "string"
                  }
                },
                "gtin": "string",
                "brand": {
                  "raw_name": "string"
                }
              }
            ],
            "id": "string"
          }
        ],
        "instructions": {
          "steps": [
            {
              "text": "string",
              "images": [
                {
                  "responsive": {
                    "url": "string",
                    "width": 0,
                    "height": 0,
                    "selection": {
                      "x": 0,
                      "y": 0,
                      "width": 0,
                      "height": 0
                    }
                  },
                  "url": "string"
                }
              ],
              "group": "string",
              "intents": [
                {
                  "name": "string",
                  "options": [
                    {
                      "key": "string",
                      "value": 0,
                      "unit": "string"
                    }
                  ]
                }
              ],
              "instruction_intents": {
                "intents": [
                  {
                    "attributes": [
                      {
                        "duration": {
                          "value": {
                            "range_value": {
                              "from": 0,
                              "to": 0
                            },
                            "plain_value": 0
                          },
                          "unit": "UNIT_INVALID"
                        },
                        "temperature": {
                          "value": {
                            "range_value": {
                              "from": 0,
                              "to": 0
                            },
                            "plain_value": 0
                          },
                          "unit": "UNIT_INVALID"
                        },
                        "gas": {
                          "value": {
                            "range_value": {
                              "from": 0,
                              "to": 0
                            },
                            "plain_value": 0
                          },
                          "unit": "UNIT_INVALID"
                        },
                        "heat": {
                          "value": "LEVEL_INVALID",
                          "unit": "UNIT_INVALID"
                        },
                        "power": {
                          "value": {
                            "range_value": {
                              "from": 0,
                              "to": 0
                            },
                            "plain_value": 0
                          },
                          "unit": "UNIT_INVALID"
                        },
                        "weight": {
                          "value": {
                            "range_value": {
                              "from": 0,
                              "to": 0
                            },
                            "plain_value": 0
                          },
                          "unit": "UNIT_INVALID"
                        },
                        "speed": {
                          "value": "LEVEL_INVALID",
                          "unit": "UNIT_INVALID"
                        },
                        "temperature_level": {
                          "value": "LEVEL_INVALID",
                          "unit": "UNIT_INVALID"
                        },
                        "water_purifier_volume": {
                          "value": "VALUE_INVALID",
                          "unit": "UNIT_INVALID"
                        },
                        "amount": {
                          "value": {
                            "range_value": {
                              "from": 0,
                              "to": 0
                            },
                            "plain_value": 0
                          },
                          "unit": "UNIT_INVALID"
                        }
                      }
                    ],
                    "equipment_action": {
                      "oven": {
                        "mode": "MODE_INVALID"
                      },
                      "air_fryer": {
                        "mode": "MODE_INVALID"
                      },
                      "cooktop": {
                        "mode": "MODE_INVALID"
                      },
                      "microwave": {
                        "mode": "MODE_INVALID"
                      },
                      "grill": {
                        "mode": "MODE_INVALID"
                      },
                      "slow_cooker": {
                        "mode": "MODE_INVALID"
                      },
                      "pressure_cooker": {
                        "mode": "MODE_INVALID"
                      },
                      "food_processor": {
                        "mode": "MODE_INVALID"
                      },
                      "blender": {
                        "mode": "MODE_INVALID"
                      },
                      "mixer": {
                        "mode": "MODE_INVALID"
                      },
                      "frying_pan": {},
                      "whisk": {},
                      "pot": {},
                      "baking_sheet": {},
                      "baking_dish": {},
                      "foil": {},
                      "fork": {},
                      "knife": {},
                      "glass": {},
                      "plastic_wrap": {},
                      "spatula": {},
                      "parchment_paper": {},
                      "toothpick": {},
                      "thermometer": {},
                      "skewer": {},
                      "oven_bag": {},
                      "ladle": {},
                      "garlic_press": {},
                      "rolling_pin": {},
                      "measuring_cup": {},
                      "tongs": {},
                      "strainer": {},
                      "shaker": {},
                      "baking_rack": {},
                      "bowl": {},
                      "bundt_pan": {},
                      "cake_pan": {},
                      "casserole_dish": {},
                      "cast_iron_pot": {},
                      "cast_iron_skillet": {},
                      "colander": {},
                      "cooking_brush": {},
                      "cutting_board": {},
                      "deep_fryer": {
                        "mode": "MODE_INVALID"
                      },
                      "donut_pan": {},
                      "double_boiler": {},
                      "dutch_oven": {},
                      "freezer": {
                        "mode": "MODE_INVALID"
                      },
                      "fridge": {
                        "mode": "MODE_INVALID"
                      },
                      "grain_mill": {},
                      "griddle": {},
                      "ice_cream_maker": {
                        "mode": "MODE_INVALID"
                      },
                      "instant_pot": {
                        "mode": "MODE_INVALID"
                      },
                      "kitchen_towel": {},
                      "lid": {},
                      "loaf_pan": {},
                      "mandoline": {},
                      "mason_jar": {},
                      "meat_pounder": {},
                      "melon_baller": {},
                      "microwave_bowl": {},
                      "muffin_pan": {},
                      "oven_safe_bowl": {},
                      "oven_safe_skillet": {},
                      "pan": {},
                      "paper_towel": {},
                      "peeler": {},
                      "plate": {},
                      "platter": {},
                      "potato_masher": {},
                      "ramekin": {},
                      "sauce_pan": {},
                      "saute_pan": {},
                      "sieve": {},
                      "skillet": {},
                      "slotted_spoon": {},
                      "slow_cooker_liner": {},
                      "spoon": {},
                      "spring_pan": {},
                      "tray": {},
                      "waffle_iron": {
                        "mode": "MODE_INVALID"
                      },
                      "water_purifier": {
                        "mode": "MODE_INVALID"
                      },
                      "wok": {},
                      "wooden_spoon": {},
                      "zip_top_bag": {}
                    }
                  }
                ]
              },
              "cooking_intents": {
                "intents": [
                  {
                    "device": {
                      "name": {
                        "name": "string",
                        "display_name": "string"
                      },
                      "image_url": "string"
                    },
                    "mode": {
                      "name": "string",
                      "display_name": "string"
                    },
                    "attributes": [
                      {
                        "type": "COOKING_INTENT_ATTRIBUTE_TYPE_INVALID",
                        "value_type": "COOKING_INTENT_ATTRIBUTE_VALUE_TYPE_INVALID",
                        "name": {
                          "name": "string",
                          "display_name": "string"
                        },
                        "value_format": "string",
                        "int_value": {
                          "value": 0,
                          "unit": {
                            "name": "string",
                            "display_name": "string"
                          }
                        },
                        "double_value": {
                          "value": 0,
                          "unit": {
                            "name": "string",
                            "display_name": "string"
                          }
                        },
                        "string_value": {
                          "value": {
                            "name": "string",
                            "display_name": "string"
                          },
                          "unit": {
                            "name": "string",
                            "display_name": "string"
                          }
                        }
                      }
                    ]
                  }
                ]
              },
              "labels": [
                {
                  "name": "string",
                  "labels": [
                    {
                      "name": "string"
                    }
                  ]
                }
              ],
              "ingredient_ids": [
                "string"
              ]
            }
          ]
        },
        "images": [
          {
            "responsive": {
              "url": "string",
              "width": 0,
              "height": 0,
              "selection": {
                "x": 0,
                "y": 0,
                "width": 0,
                "height": 0
              }
            },
            "url": "string"
          }
        ],
        "servings": 0,
        "servings_scaled": 0,
        "durations": {
          "cook_time": 0,
          "prep_time": 0,
          "total_time": 0
        },
        "normalized_ingredients": [
          {
            "text": "string",
            "group": "string",
            "analysis": {
              "product": {
                "canonical_name": "string",
                "original_name": "string"
              },
              "category": {
                "canonical_name": "string"
              },
              "brand": {
                "canonical_name": "string"
              },
              "quantity": 0,
              "unit": "string",
              "multiplier": 0,
              "comment": "string",
              "image_url": "string",
              "alternative_measurements": [
                {
                  "measurement_system": "MEASUREMENT_SYSTEM_INVALID",
                  "amount": {
                    "quantity": 0,
                    "unit": "string",
                    "multiplier": 0
                  }
                }
              ],
              "alternative_amounts": [
                {
                  "quantity": 0,
                  "unit": "string",
                  "multiplier": 0
                }
              ]
            },
            "source_text": "string",
            "labels": [
              {
                "name": "string",
                "labels": [
                  {
                    "name": "string"
                  }
                ]
              }
            ],
            "id": "string",
            "raw_id": "string",
            "nutrition": {
              "components": [
                {
                  "label": "string",
                  "code": "NUTRITION_CODE_INVALID",
                  "code_translated": {
                    "name": "string",
                    "display_name": "string"
                  },
                  "value": 0,
                  "unit": "NUTRITION_UNIT_INVALID",
                  "unit_translated": {
                    "name": "string",
                    "display_name": "string"
                  }
                }
              ]
            }
          }
        ],
        "nutrition": {
          "status": "STATUS_INVALID",
          "total": [
            {
              "label": "string",
              "code": "NUTRITION_CODE_INVALID",
              "code_translated": {
                "name": "string",
                "display_name": "string"
              },
              "value": 0,
              "unit": "NUTRITION_UNIT_INVALID",
              "unit_translated": {
                "name": "string",
                "display_name": "string"
              }
            }
          ],
          "coverage": 0,
          "labels": [
            {
              "name": "string",
              "display_name": "string"
            }
          ],
          "health_score": {
            "value": 0,
            "nutrients_influence": [
              {
                "code": "NUTRITION_CODE_INVALID",
                "code_translated": {
                  "name": "string",
                  "display_name": "string"
                },
                "influence": 0,
                "comment": "string"
              }
            ]
          },
          "glycemic_index": {
            "value": 0
          },
          "glycemic_load": {
            "value": 0
          }
        },
        "labels": {
          "meal_type": [
            {
              "name": "string",
              "display_name": "string"
            }
          ],
          "cuisine": [
            {
              "name": "string",
              "display_name": "string"
            }
          ],
          "category": [
            {
              "name": "string",
              "display_name": "string"
            }
          ],
          "technique": [
            {
              "name": "string",
              "display_name": "string"
            }
          ],
          "holiday": [
            {
              "name": "string",
              "display_name": "string"
            }
          ],
          "seasonality": [
            {
              "name": "string",
              "display_name": "string"
            }
          ],
          "device": [
            {
              "name": "string",
              "display_name": "string"
            }
          ]
        },
        "constraints": {
          "violates": {
            "diets": [
              "DIET_INVALID"
            ],
            "avoidances": [
              "AVOIDANCE_INVALID"
            ]
          }
        },
        "saved": {
          "value": true,
          "collection_ids": [
            "string"
          ],
          "owner": true,
          "recipe_type": "RECIPE_TYPE_INVALID"
        },
        "language": "string",
        "custom_labels": [
          {
            "name": "string",
            "labels": [
              {
                "name": "string"
              }
            ]
          }
        ],
        "main_ingredients": [
          "string"
        ],
        "save_count": 0,
        "recipe_availability": {
          "available_everywhere": {},
          "banned_in_some_communities": {
            "community_ids": [
              "string"
            ]
          },
          "banned_in_all_communities": {},
          "banned_everywhere": {},
          "private_tweak": {}
        },
        "content_policy_violation": {
          "violated": true,
          "text_status": "MODERATION_STATUS_INVALID",
          "image_status": "MODERATION_STATUS_INVALID",
          "ingredients_status": "MODERATION_STATUS_INVALID"
        },
        "source": {
          "name": "string",
          "display_name": "string",
          "source_recipe_url": "string",
          "image": {
            "responsive": {
              "url": "string",
              "width": 0,
              "height": 0,
              "selection": {
                "x": 0,
                "y": 0,
                "width": 0,
                "height": 0
              }
            },
            "url": "string"
          },
          "license": "LICENCE_INVALID"
        },
        "creator": {
          "id": "string",
          "first_name": "string",
          "last_name": "string",
          "username": "string",
          "picture": {
            "url": "string",
            "width": 0,
            "height": 0,
            "selection": {
              "x": 0,
              "y": 0,
              "width": 0,
              "height": 0
            }
          },
          "relation": {
            "is_following": true,
            "is_followed_by": true,
            "is_me": true
          }
        },
        "author": {
          "name": "string",
          "image": {
            "responsive": {
              "url": "string",
              "width": 0,
              "height": 0,
              "selection": {
                "x": 0,
                "y": 0,
                "width": 0,
                "height": 0
              }
            },
            "url": "string"
          },
          "url": "string"
        },
        "recipe_author": {
          "publisher": {
            "name": "string",
            "display_name": "string",
            "source_recipe_url": "string",
            "image": {
              "responsive": {
                "url": "string",
                "width": 0,
                "height": 0,
                "selection": {
                  "x": 0,
                  "y": 0,
                  "width": 0,
                  "height": 0
                }
              },
              "url": "string"
            }
          },
          "user": {
            "id": "string",
            "first_name": "string",
            "last_name": "string",
            "username": "string",
            "picture": {
              "url": "string",
              "width": 0,
              "height": 0,
              "selection": {
                "x": 0,
                "y": 0,
                "width": 0,
                "height": 0
              }
            },
            "relation": {
              "is_following": true,
              "is_followed_by": true,
              "is_me": true
            }
          }
        },
        "parent": {
          "recipe": {
            "id": "string",
            "name": "string",
            "images": [
              {
                "responsive": {
                  "url": "string",
                  "width": 0,
                  "height": 0,
                  "selection": {
                    "x": 0,
                    "y": 0,
                    "width": 0,
                    "height": 0
                  }
                },
                "url": "string"
              }
            ],
            "source": {
              "name": "string",
              "display_name": "string",
              "source_recipe_url": "string"
            }
          }
        },
        "permissions": {
          "is_instructions_enabled": true,
          "is_guided_cooking_enabled": true
        },
        "videos": [
          {
            "content_url": "string",
            "embed_url": "string",
            "thumbnail": "string"
          }
        ],
        "recipe_videos": [
          {
            "youtube_video": {
              "original_link": "string",
              "normalized_link": "string",
              "video_id": "string"
            },
            "tiktok_video": {
              "original_link": "string",
              "normalized_link": "string",
              "video_id": "string"
            }
          }
        ],
        "reviews": {
          "stats": {
            "like_count": 0,
            "dislike_count": 0
          },
          "tags": {
            "tags": [
              {
                "name": "string",
                "display_name": "string"
              }
            ]
          }
        }
      }
    }
  ],
  "paging": {
    "cursors": {
      "after": "string",
      "before": "string"
    },
    "total": "string"
  }
}

Sample Request

Last updated