Lexicon Garden

io.kich.pantry.listItems

List a household's pantry items. Items with status `finished` are never returned — they are history, not stock.

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

Query

query · GET

Parameters

query string

cursor

string

expiringWithinDays

integer

Only items that turn within this many days

  • minimum: 1
  • maximum: 365

household

requiredstring

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

limit

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

status

string

Only items in this state

  • knownValues: in_stock | low | depleted

Output

application/json

cursor

string

Absent when there is no further page.

items

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. Deliberately the same error for both: a caller holding the wrong token learns nothing about which households exist.

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.

  • io.kich.recipe.listRecipes

    query

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

  • io.kich.grocery.getCurrentList

    query

    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.

  • io.kich.pantry.defs

    object

    Shared definitions for the pantry namespace. The pantry has no record type — it lives in the application database rather than on a PDS — so these views exist only as query output.