planning-center-monorepo v1.0.0

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

Interface: WorkflowPageOptions

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

Strictly typed options for Workflow getPage() - includes pagination

Extends

• WorkflowListOptions

Properties

where?

optional where: WorkflowWhereClause

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

Filter by specific fields

Inherited from

WorkflowListOptions.where

include?

optional include: WorkflowInclude[]

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

Include related resources

Inherited from

WorkflowListOptions.include

order?

optional order: "-created_at" | "-updated_at" | "-name" | "-deleted_at" | WorkflowOrderField | "-archived_at" | "-campus_id" | "-workflow_category_id"

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

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

Inherited from

WorkflowListOptions.order

perPage?

optional perPage: number

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

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

page?

optional page: number

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

Page number