Skip to main content
GET
List all households

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

headContactId
string | null
contacts
string | null
query
string | null
sortBy
string | null
sortByDesc
string | null
page
string
default:1

Response

Array of HouseholdResource

id
integer
required
name
string
required
head_contact_id
integer | null
required
account_id
integer
required
envelope_name
string | null
required
note
string | null
required
created_at
string<date-time> | null
required
updated_at
string<date-time> | null
required
contacts
object[]