Skip to main content
GET
List active households

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Query Parameters

page
integer

One-based page.

Example:

1

per_page
integer

Rows per page; defaults 10 (not clamped by this controller).

Example:

10

Partial household search match.

Example:

"Doe"

name
string

Partial household name match.

Example:

"Doe"

city
string

Partial household city match.

Example:

"Kampala"

state
string

Partial household state match.

Example:

"Kampala"

postal_code
string

Partial household postal_code match.

Example:

"Kampala"

primary_contact_id
integer

Exact primary donor match.

Example:

42

sort_by
enum<string>

Sort column; default created_at, unsupported choices fall back.

Available options:
name,
created_at,
updated_at
Example:

"name"

sort_dir
enum<string>

Sort direction; default desc.

Available options:
asc,
desc
Example:

"asc"

Response

List active households completed.

success
boolean

Query succeeded.

Example:

true

total
integer

Matching household count.

Example:

42

per_page
integer

Rows per page.

Example:

42

current_page
integer

Current page.

Example:

42

last_page
integer

Last page.

Example:

42

households
object[]
emailsets
object[]