Skip to main content
GET
List households

Authorizations

Authorization
string
header
required

API key authentication. Use Authorization: Bearer idx_....

Query Parameters

Search households by name or related text.

page
integer

Page number (1-based).

Required range: x >= 1
pageSize
integer

Page size.

Required range: 1 <= x <= 1000
sortBy
enum<string>

Sort column.

Available options:
name,
members,
createdAt
sortOrder
enum<string>

Sort direction.

Available options:
asc,
desc
excludeSample
boolean

When true, excludes sample households.

isSample
boolean

When true, returns only sample households.

ids
string

Filter by household UUIDs. Use repeated ids query keys and/or comma-separated values.

Response

Paginated households

households
object[]
required
Maximum array length: 1000
total
integer
required
page
integer
required
pageSize
integer
required