Get Recipes from a Community
This endpoint retrieves a list of recipes from a specific community using the community identifier and pagination filters.
Get Recipes by Community ID
GET
https://api.whisk.com/community/v2/{community_id}/recipes
You can append the following path and query parameters to the base URL to pull recipes from a particular community:
Path Parameters
community_id
string
The community identifier.
Query Parameters
fields
array
Any additional recipe details to retrieve. You can choose one or more of these supported values:
- 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
Note: For performance reasons, we recommend using this parameter only when required.
paging.limit
string
The maximum number of recipes to retrieve from the community.
paging.cursors.after
string
This parameter is used for cursor-based pagination. It takes a recipe ID as its value and retrieves only those recipes that appear after it in the database.
paging.cursors.before
string
This parameter is used for cursor-based pagination. It takes a recipe ID as its value and retrieves only those recipes that appear before it in the database
Headers
Authentication
string
User token to authorize the API usage. For more information, see Authentication.
{
"recipes": [
{
"recipe": {
"id": "string",
"name": "string",
"description": "string",
"ingredients": [
...
],
"instructions": {
...
},
"images": [
...
],
"videos": [
...
],
"source": {
...
},
"servings": 0,
"servings_scaled": 0,
"durations": {
...
},
"normalized_ingredients": [
...
],
"nutrition": {
...
},
"labels": {
...
},
"constraints": {
...
},
"saved": {
...
},
"author": {
...
},
"language": "string",
"custom_labels": [
...
]
}
}
],
"paging": {
"cursors": {
"after": "string",
"before": "string"
},
"total": "string"
}
}
Sample Request and Response
curl -X GET "https://api.whisk.com/community/v2/39d539c738eb47debfb1a6319d34235a/recipes?fields=RECIPE_FIELD_NORMALIZED_INGREDIENTS&fields=RECIPE_FIELD_INSTRUCTIONS&fields=RECIPE_FIELD_INSTRUCTION_INTENTS&fields=RECIPE_FIELD_NUTRITION&fields=RECIPE_FIELD_NUTRITION_COVERAGE&fields=RECIPE_FIELD_SAVED&fields=RECIPE_FIELD_INGREDIENTS_LINKED_PRODUCTS"
-H "Accept: application/json"
-H "Authorization: Bearer <YOUR-API-ACCESS-KEY>"
Last updated
Was this helpful?