API ReferenceHouseholds

List Households

List all households

Query parameters

fieldsstringOptionalformat: "^([a-zA-Z\.],?)+$"
Specific fields requested in the response. Defaults to all fields.
sortstringOptionalformat: "^([a-zA-Z]+(:(asc|desc)+)?,?)+$"

CSV of sort value pairs by field (eg. date:asc). Sorts descending date fields by default and ascending elsewhere

filterstringOptional

Filter expression as defined by Fortress Query Language (FQL)

pageintegerOptionalDefaults to 0
the page number when used with pagination, defaults to 0
limitintegerOptionalDefaults to 10

How many items to return at one time (default 10)

Response

A paged array of households
applicationobject or null
applicationIdstring or nullformat: "uuid"
attachmentslist of objects or null
balanceobject or null
certificationslist of objects or null
claimslist of objects or null
configurationany or null
createdAtdatetime or null
currentCertificationobject or null
currentCertificationIdstring or nullformat: "uuid"
currentLeaseIdstring or nullformat: "uuid"
Current active lease for the household.
currentUnitIdstring or nullformat: "uuid"
Current unit the household is associated with. Set only when the lease is active
customerslist of objects or null
deletedAtdatetime or null
documentslist of objects or null
glEntrieslist of objects or null
idstring or nullformat: "uuid"
idempotencyIdstring or nullformat: "uuid"
isUnderEvictionboolean or null
leaseobject or null
leaseslist of objects or null
moveOutslist of objects or null
organizationany or null
organizationIdstring or nullformat: "uuid"
primaryCustomerobject or null
primaryCustomerIdstring or nullformat: "uuid"
propertyobject or null
propertyIdstring or nullformat: "uuid"
prospectobject or null
prospectIdstring or nullformat: "uuid"
readableIdstring or null
reversalslist of objects or null
scheduledTransactionslist of objects or null
screeningslist of objects or null
statusenum or null
Allowed values:
totalActiveFeesAmountdouble or null

Sum of all active non-optional fee (charge) monthly lease transactions for the household

totalActiveRentAmountdouble or null
Sum of all active RENT monthly lease transactions for the household
totalActiveSubsidyAmountdouble or null
Sum of all active SUBRENT monthly lease transactions for the household
transactionslist of objects or null
unitobject or null
updatedAtdatetime or null
workOrderslist of objects or null
unitIdstring or nullformat: "uuid"Deprecated
Deprecated, use currentUnitId instead