Households Overview

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.

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`	List Households	GET
`/households`	Create Household	POST
`/households/{householdId}`	Read Household	GET
`/households/{householdId}`	Update Household	PUT
`/households/{householdId}`	Delete Household	DELETE
`/households/{householdId}/documents`	Create Document	POST
`/households/{householdId}/leslieConfiguration`	Read Leslie Configuration	GET
`/households/{householdId}/leslieConfiguration`	Update Leslie Configuration	PUT