io.kich.pantry.listItems

kich.io

Documentation

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

main query

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

Parameters

cursor string Optional

No description available.

expiringWithinDays integer Optional

Only items that turn within this many days

household string Required

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

limit integer Optional

No description available.

status string Optional

Only items in this state

Output

Encodingapplication/json
cursor string Optional

Absent when there is no further page.

items array Required

No description available.

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.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Only items that turn within this many days
The household whose pantry to read. Must be the household the credential is scoped to.
Only items in this state
View raw schema 
{
  "description": "List a household's pantry items. Items with status `finished` are never returned — they are history, not stock.",
  "errors": [
    {
      "description": "No bearer token, or one this endpoint does not accept.",
      "name": "AuthRequired"
    },
    {
      "description": "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.",
      "name": "HouseholdNotFound"
    },
    {
      "description": "The cursor was not one this endpoint issued.",
      "name": "InvalidCursor"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cursor": {
          "description": "Absent when there is no further page.",
          "type": "string"
        },
        "items": {
          "items": {
            "ref": "io.kich.pantry.defs#pantryItemView",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "items"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "cursor": {
        "type": "string"
      },
      "expiringWithinDays": {
        "description": "Only items that turn within this many days",
        "maximum": 365,
        "minimum": 1,
        "type": "integer"
      },
      "household": {
        "description": "The household whose pantry to read. Must be the household the credential is scoped to.",
        "type": "string"
      },
      "limit": {
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      },
      "status": {
        "description": "Only items in this state",
        "knownValues": [
          "in_stock",
          "low",
          "depleted"
        ],
        "type": "string"
      }
    },
    "required": [
      "household"
    ],
    "type": "params"
  },
  "type": "query"
}

Lexicon Garden

@