API Reference

Households

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Delete a household

delete/households/{id}

Soft delete a household (marks as deleted but preserves data)

Path ParametersExpand Collapse

id: string

Delete a household

HTTP

HTTP

TypeScript

Python

curl https://$WITHLUMINARY_SUBDOMAIN.withluminary.com/api/public/v1/households/$ID \
    -X DELETE

Returns Examples