Relationships
List relationships (household alias)
Alias for GET /api/v1/households. Rewrites to the households route; response JSON uses household / households / householdId field names.
GET
List relationships (household alias)
Authorizations
API key authentication. Use Authorization: Bearer idx_....
Query Parameters
Search households by name or related text.
Page number (1-based).
Required range:
x >= 1Page size.
Required range:
1 <= x <= 1000Sort column.
Available options:
name, members, createdAt Sort direction.
Available options:
asc, desc When true, excludes sample households.
When true, returns only sample households.
Filter by household UUIDs. Use repeated ids query keys and/or comma-separated values.