API Reference

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

Available Endpoints

EndpointSummaryMethod
/householdsList HouseholdsGET
/householdsCreate HouseholdPOST
/households/{householdId}Read HouseholdGET
/households/{householdId}Update HouseholdPUT
/households/{householdId}Delete HouseholdDELETE
/households/{householdId}/documentsCreate DocumentPOST