v1

latestOpenAPI 3.1.02026-07-266850126.1 KB

Households

List all households

get/v1/households

Query parameters

headContactIdstring nullable

contactsstring nullable

querystring nullable

sortBystring nullable

sortByDescstring nullable

pagestring

Response

Array of HouseholdResource

idinteger required

namestring required

head_contact_idinteger nullable required

account_idinteger required

envelope_namestring nullable required

notestring nullable required

created_atstring date-time nullable required

updated_atstring date-time nullable required