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

Interface: PersonListOptions

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

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

Extended by

PersonPageOptions

Properties

where?

optional where: PersonWhereClause

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

Filter by specific fields

include?

optional include: PersonInclude[]

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

Include related resources

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)