Skip to main content
GET
List all households

Authorizations

Authorization
string
header
required

OAuth 2.0 Bearer Token from Clerk authentication

Query Parameters

book_id
string

Filter by book ID to scope to a specific book

household_type
enum<string>

Filter by household type

Available options:
client,
prospect,
past_client
type
enum<string>

Alias for household_type

Available options:
client,
prospect,
past_client
updated_since
string

Filter households updated since this ISO8601 timestamp

email
string

Filter by exact email match after normalization

phone
string

Filter by exact phone match (E.164 format)

name
string

Filter by person name (prefix/full-text match, not arbitrary substring)

page
integer

Page number

per_page
integer

Items per page (max 100)

Response

successful

data
object[]
required
pagination
object
required