Skip to Content
APIPlanning Center People TSSrcInterfacesInterface: ListListOptions

planning-center-monorepo v1.0.0


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

Interface: ListListOptions

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

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

Extended by

Properties

where?

optional where: ListWhereClause

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

Filter by specific fields


include?

optional include: ListInclude[]

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

Include related resources


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)