planning-center-monorepo v1.0.0

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

Interface: FormPageOptions

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

Strictly typed options for Form getPage() - includes pagination

Extends

• FormListOptions

Properties

where?

optional where: FormWhereClause

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

Filter by specific fields

Inherited from

FormListOptions.where

include?

optional include: string[]

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

Include related resources

Inherited from

FormListOptions.include

order?

optional order: string

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

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

Inherited from

FormListOptions.order

perPage?

optional perPage: number

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

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

page?

optional page: number

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

Page number