planning-center-monorepo v1.0.0

planning-center-monorepo / planning-center-people-ts/src / HouseholdListOptions

Interface: HouseholdListOptions

Defined in: packages/planning-center-people-ts/src/types/api-options.ts:364 

Strictly typed options for Household getAll() - no pagination options

Extended by

• HouseholdPageOptions

Properties

where?

optional where: HouseholdWhereClause

Defined in: packages/planning-center-people-ts/src/types/api-options.ts:366 

Filter by specific fields

include?

optional include: HouseholdInclude[]

Defined in: packages/planning-center-people-ts/src/types/api-options.ts:368 

Include related resources

order?

optional order: "-created_at" | "-updated_at" | "-name" | HouseholdOrderField | "-member_count" | "-primary_contact_name"

Defined in: packages/planning-center-people-ts/src/types/api-options.ts:370 

Order by field (prefix with ’-’ for descending)