---
title: "Dated deadlines and age milestones for one household"
method: GET
path: "/api/v1/households/{id}/calendar"
tags: ["households"]
---

# Dated deadlines and age milestones for one household

`GET /api/v1/households/{id}/calendar`

## Request

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

Statutory due dates (moved past weekends and DC legal holidays, IRC §7503), enrollment windows and age milestones between from and to, each with its source, the strategies it bears on and its precision. A read: no meter.

## Query parameters

- `from` string, date
- `to` string, date

## Response `200`

The calendar, sorted by date.

- object
  - `ok` unknown, required
  - `householdId` integer, required
  - `householdVersion` integer, required
  - `from` string, date, required
  - `to` string, date, required
  - `specVersion` string, required
  - `entries` CalendarEntry[], required
    - `key` string, required: Stable identity of this occurrence: rule, member (or household) and date or year.
    - `ruleId` string, required
    - `label` string, required
    - `why` string, required
    - `strategies` string[], required
    - `source` object, required
      - `name` string, required
      - `url` string, required
    - `memberId` string, nullable, required
    - `precision` 'day' | 'window' | 'year', required: day: an exact due date; window: a period (date to endDate); year: a milestone placed in its calendar year (birth dates are not in the household record).
    - `date` string, date, required: The due date, the window's first day, or January 1 of the milestone's year.
    - `endDate` string, date
    - `year` integer
    - `note` string
  - `notes` string[], required

## Other responses

- `400`: from or to is not a date, to is before from, or the range exceeds ten years.
- `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).
- `404`: No household with this id in the key's organization.
- `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)