io.kich.recipe.listRecipes

List a household's recipes. Ordered by how much of each the pantry already covers, descending, then by name — so the first page is the part of the cookbook that needs no shopping.

Repository @kich.io did:plc:uxjwdy4wvuridijisalvxlxe namespace authority
Details · query
Kindquery
Authorityrecipe.kich.io
Indexed

Query

query · GET

Parameters

query string

Only recipes in this collection, by id

cursor

string

household

requiredstring

The household whose recipes to read. Must be the household the credential is scoped to.

limit

integer
  • minimum: 1
  • maximum: 100
  • default: 50

tag

string

Only recipes carrying this tag, by id

Output

application/json

cursor

string

Absent when there is no further page.

recipes

requiredarray
itemsref

Errors

AuthRequired

No bearer token, or one this endpoint does not accept.

HouseholdNotFound

No such household, or the credential is not scoped to it.

InvalidCursor

The cursor was not one this endpoint issued.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • The household's current shopping list and the recipes attached to it — which is what 'what are we cooking this week' means in this product. Read-only.

  • What is in a household's kitchen, soonest to turn first. Read-only.

  • List recipes for a given user, optionally filtered by category.

  • Response model for fetching multiple recipes.

  • The public recipe index, unfiltered and unauthenticated. It exists to prove the indexer works before there is a pantry to match against, and stays because an AppView that cannot show what it indexed is hard to debug.