planning-center-monorepo v1.0.0

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

Interface: ListPageOptions

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

Strictly typed options for List getPage() - includes pagination

Extends

• ListListOptions

Properties

where?

optional where: ListWhereClause

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

Filter by specific fields

Inherited from

ListListOptions.where

include?

optional include: ListInclude[]

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

Include related resources

Inherited from

ListListOptions.include

order?

optional order: "-created_at" | "-updated_at" | "-name" | "-campus_id" | ListOrderField | "-batch_completed_at" | "-list_categories.name" | "-list_category_id" | "-name_or_description"

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

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

Inherited from

ListListOptions.order

perPage?

optional perPage: number

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

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

page?

optional page: number

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

Page number