List the user's whole recipe book (own + saved + queued + friend recipes), optionally filtered by title words, course, or ownership. Narrow with a filter when you can: the unfiltered book can run to well over a thousand rows. Each row has id, title, owned, and whichever of course_title, cuisine_title, main_ingredient_title, tag_titles, total_time (minutes) and rating are set — empty ones are left out. Rows carry no ingredients, directions, description, servings or nutrition — call get_recipe on an id for those. Inactive, removed and hidden recipes are left out.

Get a single recipe by id, including directions, ingredients, tags, prep_notes, comments.

Create a new recipe. Only title is required. Ingredients are an array of {title, amount, unit, note, position}.

Update an existing recipe. Pass only the fields you want to change. To remove an ingredient include {id, _destroy: true} in ingredients.

Delete a recipe by id.

List all courses (Appetizers, Main Course, etc.).

List all cuisines.

List all main-ingredient categories.

List all tags.

List the user's grocery stores. Use the ids as store_id when adding or re-filing shopping list items.

List the user's grocery aisles (Produce, Dairy, ...). Use the ids as category_id on shopping list items.

List all planner (calendar) events. Each entry: { date, recipe_id, section, servings, ... }.

Fetch all planner events between start_date and end_date (inclusive, YYYY-MM-DD). end_date defaults to start_date + 6 days. Recipe events are enriched with recipe_title.

Find planner events for a given recipe, optionally constrained to a date range. Useful for "is this recipe already planned this week?" checks before scheduling.

Add a recipe to a meal slot on the planner. Returns the newly created event (id, date, section, servings, ...).

Add a freeform "ingredient" entry to a meal slot (e.g. "2 lbs ground beef" attached to Wednesday dinner).

Add a freeform "note" entry to a meal slot (e.g. "Defrost chicken" on Tuesday breakfast).

Schedule a leftover meal derived from a previously planned recipe event. Duplicates the source event with plan_leftover=true and optionally moves the duplicate to a different date/section. Returns the new event.

Move an existing planner event to a different date and/or section. Works for recipe, note, and ingredient events.

Reorder events within a section. Pass event_ids in the desired order. All events should belong to the same date+section for the reorder to be meaningful.

Update the text of a note or ingredient planner entry. Note: uses the description field on the wire even though entries are created with title.

Set the servings count on a recipe planner event.

Duplicate a planner event. Set plan_leftover=true to mark the copy as a leftover.

Delete a planner event by id.

Update planner display/behaviour preferences (time_zone, planner_start_day, calendar_settings.show_calories, etc). Use Rails-style nested keys like user[time_zone] or calendar_settings[show_calories]. Rarely needed.

List what's in the freezer. Each entry: { id, recipe_id, count, servings, frozen_on }. By default only returns active entries (count > 0); pass include_consumed=true to also see history (the API soft-deletes by zeroing the count rather than removing the row).

Mark N portions of a previously cooked recipe as frozen. event_id ties the frozen entry back to the planner event the portions came from.

Mark a frozen entry as consumed (the portion was eaten or thrown out). Soft-delete: API sets count to 0; the entry persists as history.

Read the shopping list. Each line gives what to buy plus the store it's assigned to (store_title / store_id, where a null store_id means the account's default store) and the aisle it's filed under (grocery_category_title / grocery_category_id). item_ids is the handle for updating or removing that line — Plan to Eat merges duplicate ingredients into one line, so it's an array. recipe_ids shows which planned recipes pulled the item in.

Add items to the shopping list. Only title is required per item. Leave category_id out and Plan to Eat guesses the aisle; leave store_id out and the item goes to the store it was last bought at, falling back to the default store if it's new. Returns the lines that were created.

Change shopping list lines. Pass item_ids from get_shopping_list — naming any id of a line affects that whole line. Moving items to a different store or aisle (store_id / category_id on their own) works across as many lines as you like; editing the text (title, amount, unit, note) applies to one line at a time, and collapses a merged line into a single row keeping its combined quantity. Returns the lines as they now stand, so re-read item_ids from the result rather than reusing the ones you sent.

Remove lines from the shopping list. This is a soft delete, the same one the app does, and restore_shopping_list_items undoes it — but nothing can list removed lines, so keep the item_ids around if the removal might need undoing.

Put previously removed shopping list lines back on the list. Takes the item_ids the line had before it was removed.

List saved menus.

List friends.

Get recipe-book counts: { friends, queued, frozen }.