planning-center-monorepo v1.0.0

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

Interface: HouseholdPageOptions

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

Strictly typed options for Household getPage() - includes pagination

Extends

• HouseholdListOptions

Properties

where?

optional where: HouseholdWhereClause

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

Filter by specific fields

Inherited from

HouseholdListOptions.where

include?

optional include: HouseholdInclude[]

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

Include related resources

Inherited from

HouseholdListOptions.include

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)

Inherited from

HouseholdListOptions.order

perPage?

optional perPage: number

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

Items per page (1-100, default: 25)

page?

optional page: number

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

Page number