io.kich.grocery.getCurrentList

kich.io

Documentation

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.

main query

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.

Parameters

household string Required

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

Output

Encodingapplication/json
list refio.kich.grocery.defs#groceryListView Optional

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.

recipes 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.
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
The household whose list to read. Must be the household the credential is scoped to.
View raw schema
{
  "description": "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.",
  "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.",
      "name": "HouseholdNotFound"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "list": {
          "description": "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.",
          "ref": "io.kich.grocery.defs#groceryListView",
          "type": "ref"
        },
        "recipes": {
          "items": {
            "ref": "io.kich.grocery.defs#plannedRecipe",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "recipes"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "household": {
        "description": "The household whose list to read. Must be the household the credential is scoped to.",
        "type": "string"
      }
    },
    "required": [
      "household"
    ],
    "type": "params"
  },
  "type": "query"
}

Lexicon Garden

@