planning-center-monorepo v1.0.0

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

Interface: PersonPageOptions

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

Strictly typed options for Person getPage() - includes pagination

Extends

• PersonListOptions

Properties

where?

optional where: PersonWhereClause

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

Filter by specific fields

Inherited from

PersonListOptions.where

include?

optional include: PersonInclude[]

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

Include related resources

Inherited from

PersonListOptions.include

order?

optional order: PersonOrderField | "-status" | "-first_name" | "-last_name" | "-given_name" | "-middle_name" | "-nickname" | "-birthdate" | "-anniversary" | "-gender" | "-grade" | "-child" | "-created_at" | "-updated_at" | "-graduation_year" | "-site_administrator" | "-accounting_administrator" | "-people_permissions" | "-membership" | "-remote_id" | "-inactivated_at"

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

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

Inherited from

PersonListOptions.order

perPage?

optional perPage: number

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

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

page?

optional page: number

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

Page number