Skip to main content
GET
List households

Authorizations

Authorization
string
header
required

OAuth 2.0 authorization code flow with PKCE (S256). See the authorization guide.

Scopes

contacts:read

Read your contacts and households

Query Parameters

query
string

Search by name. Every word must appear in the household's name, and close spellings also match.

Maximum string length: 250
updated_after
string<date-time>

Only the records whose updated_on is at or after this timestamp, which needs a time zone offset. To keep a copy in sync, pass the latest updated_on you have stored, as returned (it ends in Z); records updated in that same second come back again. Write an offset's + as %2B, since a + in a URL reads as a space.

page
integer
default:1

The page number to return, from 1 to 1,000. This is separate from the records-per-page limit.

Required range: 1 <= x <= 1000
limit
integer
default:50

Records per page, at most 100.

Required range: 1 <= x <= 100

Response

A page of households.

page
integer
required
Required range: 1 <= x <= 1000
limit
integer
required
Required range: 1 <= x <= 100
has_more
boolean
required

Whether the next page has rows.

data
object[]
required