for developers

API documentation

A small, read-only REST API for pulling your own inventory data programmatically — built for the real case of an insurance agent wanting to pull a policyholder's inventory into their own claims system, or anyone who wants to script something against their own data. This is the entire API surface — nothing hidden or undocumented.

Authentication

Generate a key from Account settings → Developer API. Every request needs it as a Bearer token — there's no session/cookie auth on this API, and a key only ever sees the data of the account that created it.

Authorization: Bearer <your-api-key>

Keep your key secret — anyone with it can read your inventory data. You can revoke a key at any time from the same account page.

GET /api/v1/inventories

Lists every inventory the key's account owns.

curl https://homeledger.casa/api/v1/inventories \
  -H "Authorization: Bearer <your-api-key>"

{
  "inventories": [
    { "id": "…", "name": "My home", "created_at": "…", "updated_at": "…" }
  ]
}

GET /api/v1/inventories/:id/items

Lists every item in one inventory. Returns 404 if the inventory doesn't exist or isn't owned by the key's account — a key can never see another account's data, regardless of the ID requested.

curl https://homeledger.casa/api/v1/inventories/<inventory-id>/items \
  -H "Authorization: Bearer <your-api-key>"

{
  "items": [
    {
      "id": "…",
      "description": "Blue leather sofa",
      "category": "Furniture",
      "brand": "IKEA",
      "model_number": "KLIPPAN",
      "estimated_value_cents": 89900,
      "estimated_current_value_cents": 62300,
      "receipt_url": null,
      "status": "active",
      "rooms": { "name": "Living room" }
    }
  ]
}

Errors

401 — missing or invalid/revoked key. 404 — inventory not found or not owned by this key.