---
title: "List the org's households (metadata)"
method: GET
path: "/api/v1/households"
tags: ["households"]
---

# List the org's households (metadata)

`GET /api/v1/households`

## Request

- Base URL: `https://worthune.com`
- URL: `https://worthune.com/api/v1/households`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`

## Response `200`

Rows without documents — GET /api/v1/households/{id} returns the document.

- object
  - `ok` unknown, required
  - `households` HouseholdListItem[], required
    - `id` integer, required
    - `label` string, nullable, required
    - `advisorRef` string, nullable, required
    - `schemaVersion` string, required
    - `version` integer, required: Monotonic write counter for optimistic concurrency.
    - `status` 'active' | 'archived', required
    - `updatedAt` string, date-time, required
    - `lastComputedAt` string, date-time, nullable, required

## Other responses

- `401`: No key presented (Authorization: Bearer wk_… or X-Api-Key).
- `402`: Unrecognized or revoked API key.
- `403`: The key predates organization support (contact support for a free rotation).
- `429`: Hourly per-org stateful quota, a per-route durable limit, or the 120 requests/minute per-IP burst backstop.
- `503`: Billing is not configured on this deployment; household resources are disabled rather than served without tenancy (production fail-closed).

---

[API](https://skmtc.dev/worthune/apis/worthune-api.md) · [All operations](https://skmtc.dev/worthune/apis/worthune-api/llms.txt) · [OpenAPI document](https://skmtc.dev/worthune/apis/worthune-api/revisions/9f2241072555?raw)