Get App Info [GET /api/app/about] Get general application information

Get Startup Info [GET /api/app/about/startup-info] returns helpful startup information

Get App Theme [GET /api/app/about/theme] Get's the current theme settings

Get Token [POST /api/auth/token]

Oauth Login [GET /api/auth/oauth]

Oauth Callback [GET /api/auth/oauth/callback]

Refresh Token [GET /api/auth/refresh] Use a valid token to get another token

Logout [POST /api/auth/logout]

Get Logged In User [GET /api/users/self]

Get Logged In User Ratings [GET /api/users/self/ratings]

Get Logged In User Rating For Recipe [GET /api/users/self/ratings/{recipe_id}]

Get Logged In User Favorites [GET /api/users/self/favorites]

Update Password [PUT /api/users/password] Resets the User Password

Update User [PUT /api/users/{item_id}]

Update User Image [POST /api/users/{id}/image] Updates a User Image

Create Api Token [POST /api/users/api-tokens] Create api_token in the Database

Delete Api Token [DELETE /api/users/api-tokens/{token_id}] Delete api_token from the Database

Get Ratings [GET /api/users/{id}/ratings] Get user's rated recipes

Get Favorites [GET /api/users/{id}/favorites] Get user's favorited recipes

Set Rating [POST /api/users/{id}/ratings/{slug}] Sets the user's rating for a recipe

Add Favorite [POST /api/users/{id}/favorites/{slug}] Adds a recipe to the user's favorites

Remove Favorite [DELETE /api/users/{id}/favorites/{slug}] Removes a recipe from the user's favorites

Get All [GET /api/households/cookbooks]

Create One [POST /api/households/cookbooks]

Update Many [PUT /api/households/cookbooks]

Get One [GET /api/households/cookbooks/{item_id}]

Update One [PUT /api/households/cookbooks/{item_id}]

Delete One [DELETE /api/households/cookbooks/{item_id}]

Get All [GET /api/households/events/notifications]

Create One [POST /api/households/events/notifications]

Get One [GET /api/households/events/notifications/{item_id}]

Update One [PUT /api/households/events/notifications/{item_id}]

Delete One [DELETE /api/households/events/notifications/{item_id}]

Test Notification [POST /api/households/events/notifications/{item_id}/test]

Get All [GET /api/households/recipe-actions]

Create One [POST /api/households/recipe-actions]

Get One [GET /api/households/recipe-actions/{item_id}]

Update One [PUT /api/households/recipe-actions/{item_id}]

Delete One [DELETE /api/households/recipe-actions/{item_id}]

Trigger Action [POST /api/households/recipe-actions/{item_id}/trigger/{recipe_slug}]

Get Logged In User Household [GET /api/households/self] Returns the Household Data for the Current User

Get Household Recipe [GET /api/households/self/recipes/{recipe_slug}] Returns recipe data for the current household

Get Household Members [GET /api/households/members] Returns all users belonging to the current household

Get Household Preferences [GET /api/households/preferences]

Update Household Preferences [PUT /api/households/preferences]

Set Member Permissions [PUT /api/households/permissions]

Get Statistics [GET /api/households/statistics]

Get Invite Tokens [GET /api/households/invitations]

Create Invite Token [POST /api/households/invitations]

Email Invitation [POST /api/households/invitations/email]

Get All [GET /api/households/shopping/lists]

Create One [POST /api/households/shopping/lists]

Get One [GET /api/households/shopping/lists/{item_id}]

Update One [PUT /api/households/shopping/lists/{item_id}]

Delete One [DELETE /api/households/shopping/lists/{item_id}]

Update Label Settings [PUT /api/households/shopping/lists/{item_id}/label-settings]

Add Recipe Ingredients To List [POST /api/households/shopping/lists/{item_id}/recipe]

(DEPRECATED) Add Single Recipe Ingredients To List [POST /api/households/shopping/lists/{item_id}/recipe/{recipe_id}]

Remove Recipe Ingredients From List [POST /api/households/shopping/lists/{item_id}/recipe/{recipe_id}/delete]

Get All [GET /api/households/shopping/items]

Create One [POST /api/households/shopping/items]

Update Many [PUT /api/households/shopping/items]

Delete Many [DELETE /api/households/shopping/items]

Create Many [POST /api/households/shopping/items/create-bulk]

Get One [GET /api/households/shopping/items/{item_id}]

Update One [PUT /api/households/shopping/items/{item_id}]

Delete One [DELETE /api/households/shopping/items/{item_id}]

Get All [GET /api/households/webhooks]

Create One [POST /api/households/webhooks]

Rerun Webhooks [POST /api/households/webhooks/rerun] Manually re-fires all previously scheduled webhooks for today

Get One [GET /api/households/webhooks/{item_id}]

Update One [PUT /api/households/webhooks/{item_id}]

Delete One [DELETE /api/households/webhooks/{item_id}]

Test One [POST /api/households/webhooks/{item_id}/test]

Get All [GET /api/households/mealplans/rules]

Create One [POST /api/households/mealplans/rules]

Get One [GET /api/households/mealplans/rules/{item_id}]

Update One [PUT /api/households/mealplans/rules/{item_id}]

Delete One [DELETE /api/households/mealplans/rules/{item_id}]

Get All [GET /api/households/mealplans]

Create One [POST /api/households/mealplans]

Get Todays Meals [GET /api/households/mealplans/today]

Create Random Meal [POST /api/households/mealplans/random] create_random_meal is a route that provides the randomized functionality for mealplaners. It operates by following the rules set out in the household's mealplan settings. If no settings are set, it will return any random meal.

Refer to the mealplan settings routes for more information on how rules can be applied to the random meal selector.

Get One [GET /api/households/mealplans/{item_id}]

Update One [PUT /api/households/mealplans/{item_id}]

Delete One [DELETE /api/households/mealplans/{item_id}]

Create Ai Provider [POST /api/groups/ai-providers/providers]

Get Ai Provider [GET /api/groups/ai-providers/providers/{provider_id}]

Update Ai Provider [PUT /api/groups/ai-providers/providers/{provider_id}]

Delete Ai Provider [DELETE /api/groups/ai-providers/providers/{provider_id}]

Get Ai Provider Settings [GET /api/groups/ai-providers/settings]

Update Ai Provider Settings [PUT /api/groups/ai-providers/settings]

Get All Households [GET /api/groups/households]

Get One Household [GET /api/groups/households/{household_slug}]

Get Logged In User Group [GET /api/groups/self] Returns the Group Data for the Current User

Get Group Members [GET /api/groups/members] Returns all users belonging to the current group

Get Group Member [GET /api/groups/members/{username_or_id}] Returns a single user belonging to the current group

Get Group Preferences [GET /api/groups/preferences]

Update Group Preferences [PUT /api/groups/preferences]

Get Storage [GET /api/groups/storage]

Start Data Migration [POST /api/groups/migrations]

Get All [GET /api/groups/reports]

Get One [GET /api/groups/reports/{item_id}]

Delete One [DELETE /api/groups/reports/{item_id}]

Get All [GET /api/groups/labels]

Create One [POST /api/groups/labels]

Get One [GET /api/groups/labels/{item_id}]

Update One [PUT /api/groups/labels/{item_id}]

Delete One [DELETE /api/groups/labels/{item_id}]

Seed Foods [POST /api/groups/seeders/foods]

Seed Labels [POST /api/groups/seeders/labels]

Seed Units [POST /api/groups/seeders/units]

Get Recipe Formats And Templates [GET /api/recipes/exports]

Get Recipe As Format [GET /api/recipes/{slug}/exports]

Parameters

template_name: The name of the template to use to use in the exports listed. Template type will automatically be set on the backend. Because of this, it's important that your templates have unique names. See available names and formats in the /api/recipes/exports endpoint.

Test Parse Recipe Url [POST /api/recipes/test-scrape-url]

Create Recipe From Html Or Json [POST /api/recipes/create/html-or-json] Takes in raw HTML or a https://schema.org/Recipe object as a JSON string and parses it like a URL

Parse Recipe Url [POST /api/recipes/create/url] Takes in a URL and attempts to scrape data and load it into the database

Parse Recipe Url Bulk [POST /api/recipes/create/url/bulk] Takes in a URL and attempts to scrape data and load it into the database

Create Recipe From Zip [POST /api/recipes/create/zip] Create recipe from archive

Create Recipe From Image [POST /api/recipes/create/image] Create a recipe from an image using OpenAI. Optionally specify a language for it to translate the recipe to.

Get All [GET /api/recipes]

Create One [POST /api/recipes] Takes in a JSON string and loads data into the database as a new entry

Update Many [PUT /api/recipes]

Patch Many [PATCH /api/recipes]

Suggest Recipes [GET /api/recipes/suggestions]

Get One [GET /api/recipes/{slug}] Takes in a recipe's slug or id and returns all data for a recipe

Update One [PUT /api/recipes/{slug}] Updates a recipe by existing slug and data.

Patch One [PATCH /api/recipes/{slug}] Updates a recipe by existing slug and data.

Delete One [DELETE /api/recipes/{slug}] Deletes a recipe by slug

Duplicate One [POST /api/recipes/{slug}/duplicate] Duplicates a recipe with a new custom name if given

Update Last Made [PATCH /api/recipes/{slug}/last-made] Update a recipe's last made timestamp

Scrape Image Url [POST /api/recipes/{slug}/image]

Update Recipe Image [PUT /api/recipes/{slug}/image]

Delete Recipe Image [DELETE /api/recipes/{slug}/image]

Upload Recipe Asset [POST /api/recipes/{slug}/assets] Upload a file to store as a recipe asset

Get Recipe Comments [GET /api/recipes/{slug}/comments] Get all comments for a recipe

Bulk Tag Recipes [POST /api/recipes/bulk-actions/tag]

Bulk Settings Recipes [POST /api/recipes/bulk-actions/settings]

Bulk Categorize Recipes [POST /api/recipes/bulk-actions/categorize]

Bulk Delete Recipes [POST /api/recipes/bulk-actions/delete]

Bulk Export Recipes [POST /api/recipes/bulk-actions/export]

Purge Export Data [DELETE /api/recipes/bulk-actions/export/purge] Remove all exports data, including items on disk without database entry

Get Shared Recipe [GET /api/recipes/shared/{token_id}]

Get All [GET /api/recipes/timeline/events]

Create One [POST /api/recipes/timeline/events]

Get One [GET /api/recipes/timeline/events/{item_id}]

Update One [PUT /api/recipes/timeline/events/{item_id}]

Delete One [DELETE /api/recipes/timeline/events/{item_id}]

Update Event Image [PUT /api/recipes/timeline/events/{item_id}/image]

Get All [GET /api/organizers/categories] Returns a list of available categories in the database

Create One [POST /api/organizers/categories] Creates a Category in the database

Get All Empty [GET /api/organizers/categories/empty] Returns a list of categories that do not contain any recipes

Get One [GET /api/organizers/categories/{item_id}] Returns a list of recipes associated with the provided category.

Update One [PUT /api/organizers/categories/{item_id}] Updates an existing Tag in the database

Delete One [DELETE /api/organizers/categories/{item_id}] Removes a recipe category from the database. Deleting a category does not impact a recipe. The category will be removed from any recipes that contain it

Get One By Slug [GET /api/organizers/categories/slug/{category_slug}] Returns a category object with the associated recieps relating to the category

Get All [GET /api/organizers/tags] Returns a list of available tags in the database

Create One [POST /api/organizers/tags] Creates a Tag in the database

Get Empty Tags [GET /api/organizers/tags/empty] Returns a list of tags that do not contain any recipes

Get One [GET /api/organizers/tags/{item_id}] Returns a list of recipes associated with the provided tag.

Update One [PUT /api/organizers/tags/{item_id}] Updates an existing Tag in the database

Delete Recipe Tag [DELETE /api/organizers/tags/{item_id}] Removes a recipe tag from the database. Deleting a tag does not impact a recipe. The tag will be removed from any recipes that contain it

Get One By Slug [GET /api/organizers/tags/slug/{tag_slug}]

Get All [GET /api/organizers/tools]

Create One [POST /api/organizers/tools]

Get One [GET /api/organizers/tools/{item_id}]

Update One [PUT /api/organizers/tools/{item_id}]

Delete One [DELETE /api/organizers/tools/{item_id}]

Get One By Slug [GET /api/organizers/tools/slug/{tool_slug}]

Get All [GET /api/shared/recipes]

Create One [POST /api/shared/recipes]

Get One [GET /api/shared/recipes/{item_id}]

Delete One [DELETE /api/shared/recipes/{item_id}]

Get All [GET /api/comments]

Create One [POST /api/comments]

Get One [GET /api/comments/{item_id}]

Update One [PUT /api/comments/{item_id}]

Delete One [DELETE /api/comments/{item_id}]

Parse Ingredient [POST /api/parser/ingredient]

Parse Ingredients [POST /api/parser/ingredients]

Get All [GET /api/foods]

Create One [POST /api/foods]

Merge One [PUT /api/foods/merge]

Get One [GET /api/foods/{item_id}]

Update One [PUT /api/foods/{item_id}]

Delete One [DELETE /api/foods/{item_id}]

Get All [GET /api/units]

Create One [POST /api/units]

Merge One [PUT /api/units/merge]

Get One [GET /api/units/{item_id}]

Update One [PUT /api/units/{item_id}]

Delete One [DELETE /api/units/{item_id}]

Get All [GET /api/explore/groups/{group_slug}/foods]

Get One [GET /api/explore/groups/{group_slug}/foods/{item_id}]

Get All [GET /api/explore/groups/{group_slug}/households]

Get Household [GET /api/explore/groups/{group_slug}/households/{household_slug}]

Get All [GET /api/explore/groups/{group_slug}/organizers/categories]

Get One [GET /api/explore/groups/{group_slug}/organizers/categories/{item_id}]

Get All [GET /api/explore/groups/{group_slug}/organizers/tags]

Get One [GET /api/explore/groups/{group_slug}/organizers/tags/{item_id}]

Get All [GET /api/explore/groups/{group_slug}/organizers/tools]

Get One [GET /api/explore/groups/{group_slug}/organizers/tools/{item_id}]

Get All [GET /api/explore/groups/{group_slug}/cookbooks]

Get One [GET /api/explore/groups/{group_slug}/cookbooks/{item_id}]

Get All [GET /api/explore/groups/{group_slug}/recipes]

Suggest Recipes [GET /api/explore/groups/{group_slug}/recipes/suggestions]

Get Recipe [GET /api/explore/groups/{group_slug}/recipes/{recipe_slug}]

Get Recipe Img [GET /api/media/recipes/{recipe_id}/images/{file_name}] Takes in a recipe id, returns the static image. This route is proxied in the docker image and should not hit the API in production

Get Recipe Timeline Event Img [GET /api/media/recipes/{recipe_id}/images/timeline/{timeline_event_id}/{file_name}] Takes in a recipe id and event timeline id, returns the static image. This route is proxied in the docker image and should not hit the API in production

Get Recipe Asset [GET /api/media/recipes/{recipe_id}/assets/{file_name}] Returns a recipe asset

Get User Image [GET /api/media/users/{user_id}/{file_name}] Takes in a recipe slug, returns the static image. This route is proxied in the docker image and should not hit the API in production