Lexicon Garden

io.kich.grocery.getCurrentList

Get the latest grocery list that has not been archived, together with the recipes attached to it. Ordered by `plannedDate` where one is set and by the order they were added where it is not.

Repository @kich.io did:plc:uxjwdy4wvuridijisalvxlxe namespace authority
Details · query
Kindquery
Authoritygrocery.kich.io
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

household

requiredstring

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

Output

application/json

list

ref

Absent when the household has never made a list. `recipes` is then empty too, and that is a state to draw rather than an error.

Reference

recipes

requiredarray

Errors

AuthRequired

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

HouseholdNotFound

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

Similar lexicons

semantic match

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

  • io.kich.recipe.listRecipes

    query

    A household's cookbook, most cookable first. Read-only.

  • io.kich.pantry.listItems

    query

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

  • io.kich.grocery.defs

    object

    Shared definitions for the grocery namespace. Grocery lists have no record type — they live in the application database rather than on a PDS — so these views exist only as query output.