io.kich.recipe.listRecipes

kich.io

Documentation

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.

main query

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.

Parameters

collection string Optional

Only recipes in this collection, by id

cursor string Optional

No description available.

household string Required

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

limit integer Optional

No description available.

tag string Optional

Only recipes carrying this tag, by id

Output

Encodingapplication/json
cursor string Optional

Absent when there is no further page.

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.
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 recipes in this collection, by id
The household whose recipes to read. Must be the household the credential is scoped to.
Only recipes carrying this tag, by id
View raw schema 
{
  "description": "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.",
  "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"
    },
    {
      "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"
        },
        "recipes": {
          "items": {
            "ref": "io.kich.recipe.defs#recipeView",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "recipes"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "collection": {
        "description": "Only recipes in this collection, by id",
        "type": "string"
      },
      "cursor": {
        "type": "string"
      },
      "household": {
        "description": "The household whose recipes to read. Must be the household the credential is scoped to.",
        "type": "string"
      },
      "limit": {
        "default": 50,
        "maximum": 100,
        "minimum": 1,
        "type": "integer"
      },
      "tag": {
        "description": "Only recipes carrying this tag, by id",
        "type": "string"
      }
    },
    "required": [
      "household"
    ],
    "type": "params"
  },
  "type": "query"
}

Lexicon Garden

@