> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developer.fortresstech.io/api-reference/households/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.fortresstech.io/_mcp/server.

# Households Overview

> Overview of the Households API endpoints and functionality

The Households API provides endpoints for managing and interacting with household information.

## Key Concepts

### Household Status

Households can be in various states:

* `APPLICANT`
* `RESIDENT`
* `PRIOR`

### Leslie Integration

Available by Request

Households can have the Leslie vendor integration enabled (the default) or disabled, optionally for a bounded "quiet period" via `disabledUntil`. Integrations should read `effectiveEnabled` rather than the raw `enabled` field, since `effectiveEnabled` reflects whether a quiet period has elapsed even before the stored `enabled` value is explicitly flipped back.

> **Note**
>
> This endpoint is part of our evolving API ecosystem.
> To explore availability for your integration, please contact our team.

## Available Endpoints

| Endpoint                                                                                                           | Summary                     | Method |
| ------------------------------------------------------------------------------------------------------------------ | --------------------------- | :----: |
| [`/households`](/api-reference/households/list-households)                                                         | List Households             |   GET  |
| [`/households`](/api-reference/households/create-household)                                                        | Create Household            |  POST  |
| [`/households/{householdId}`](/api-reference/households/read-household)                                            | Read Household              |   GET  |
| [`/households/{householdId}`](/api-reference/households/update-household)                                          | Update Household            |   PUT  |
| [`/households/{householdId}`](/api-reference/households/delete-household)                                          | Delete Household            | DELETE |
| [`/households/{householdId}/documents`](/api-reference/households/create-document)                                 | Create Document             |  POST  |
| [`/households/{householdId}/leslieConfiguration`](/api-reference/households/read-household-leslie-configuration)   | Read Leslie Configuration   |   GET  |
| [`/households/{householdId}/leslieConfiguration`](/api-reference/households/update-household-leslie-configuration) | Update Leslie Configuration |   PUT  |

> Overview of the Households API endpoints and functionality


## API Docs

- Households [List Households](https://developer.fortresstech.io/api-reference/households/list-households.md)
- Households [Create Household](https://developer.fortresstech.io/api-reference/households/create-household.md)
- Households [Read Household](https://developer.fortresstech.io/api-reference/households/read-household.md)
- Households [Update Household](https://developer.fortresstech.io/api-reference/households/update-household.md)
- Households [Delete Household](https://developer.fortresstech.io/api-reference/households/delete-household.md)
- Households [List Documents](https://developer.fortresstech.io/api-reference/households/list-documents.md)
- Households [Create Document](https://developer.fortresstech.io/api-reference/households/create-document.md)
- Households [Read Household Leslie Configuration](https://developer.fortresstech.io/api-reference/households/read-household-leslie-configuration.md)
- Households [Update Household Leslie Configuration](https://developer.fortresstech.io/api-reference/households/update-household-leslie-configuration.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://developer.fortresstech.io/openapi.json)
- [OpenAPI YAML](https://developer.fortresstech.io/openapi.yaml)