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

Interface: FieldDefinitionListOptions

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

Strictly typed options for FieldDefinition list endpoints

Properties

include?

optional include: FieldDefinitionInclude[]

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

Include related resources

where?

optional where: FieldDefinitionWhereClause

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

Filter by specific fields

order?

optional order: FieldDefinitionOrderField | "-name" | "-config" | "-data_type" | "-deleted_at" | "-sequence" | "-slug" | "-tab_id"

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

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

includeDeleted?

optional includeDeleted: boolean

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

Include deleted field definitions