Skip to content
Rigel docs
Open Rigel

Households

Create a household, read its settings, add or clear sample data, and see or disconnect the outside accounts connected to it.

Commands

  • PostDisconnect an outside accounthousehold.integration.disconnectDeletes the integration, its stored credential and the app records that hang off it.
  • PostClear the sample datahousehold.sample.clearDeletes everything that adding sample data made: its people, notes, recipes, products, meals, messages and the rest, including anyone's edits to those records.

Queries

Routes

  • PostCreate a householdhouseholds.createCreates a household with you as its admin, and adds you to its family.
  • GetGet a householdhouseholds.getThe household's settings and your role there.
  • PostAdd sample datasample_data.postFills the household with a made-up family's records (people and notes, a pantry, recipes, a meal plan, a calendar, a family chat and more) through the same commands people use, so you can see Rigel in use.