‘exact’: Only return matches with verified email/phone matches (high confidence)
‘fuzzy’: Return best match above threshold (default)
‘aggressive’: Return best match with lower threshold

searchStrategy?

optional searchStrategy: "single" | "multi-step"

Defined in: packages/planning-center-people-ts/src/modules/people.ts:99

Search strategy for finding matches:

‘single’: Use only the specified matchStrategy (default)
‘multi-step’: Try multiple strategies in order until a match is found:
1. Fuzzy with age preference
2. Fuzzy without age preference
3. Exact with age preference
4. Exact without age preference

campusId?

optional campusId: string

Defined in: packages/planning-center-people-ts/src/modules/people.ts:101

Campus ID to associate with the person

createIfNotFound?

optional createIfNotFound: boolean

Defined in: packages/planning-center-people-ts/src/modules/people.ts:103

If true, create a new person if no match is found (default: true)

addMissingContactInfo?

optional addMissingContactInfo: boolean

Defined in: packages/planning-center-people-ts/src/modules/people.ts:109

If true, automatically add missing email/phone contact information to a person’s profile when a match is found. Missing contacts are added as non-primary to avoid overriding existing primary contacts. (default: false)

agePreference?

optional agePreference: "adults" | "children" | "any"

Defined in: packages/planning-center-people-ts/src/modules/people.ts:111

Age preference filter: ‘adults’ (18+), ‘children’ (<18), or ‘any’

agePreferenceLenient?

optional agePreferenceLenient: boolean

Defined in: packages/planning-center-people-ts/src/modules/people.ts:117

When true, age preference filters only apply to profiles with birthdates. Profiles without birthdates are included regardless of agePreference. When false (default), profiles without birthdates only match when agePreference is ‘any’.

minAge?

optional minAge: number

Defined in: packages/planning-center-people-ts/src/modules/people.ts:119

Minimum age filter

maxAge?

optional maxAge: number

Defined in: packages/planning-center-people-ts/src/modules/people.ts:121

Maximum age filter

birthYear?

optional birthYear: number

Defined in: packages/planning-center-people-ts/src/modules/people.ts:123

Birth year filter (exact match)

retryConfig?

optional retryConfig: RetryConfig

Defined in: packages/planning-center-people-ts/src/modules/people.ts:129

Retry configuration for handling PCO contact verification delays. When a person is created, PCO needs time (30-90+ seconds) to verify/index contacts before they become searchable. This retry logic helps prevent duplicate person creation.

retryConfigs?

optional retryConfigs: object

Defined in: packages/planning-center-people-ts/src/modules/people.ts:134

Phase-specific retry configurations for advanced control. When both retryConfig and retryConfigs are provided, retryConfigs takes precedence.

initial?

optional initial: RetryConfig

Configuration for initial/quick search phase (default: 30s max wait)

aggressive?

optional aggressive: RetryConfig

Configuration for aggressive search before creating (default: 60s max wait)

fallbackToNameSearch?

optional fallbackToNameSearch: boolean

Defined in: packages/planning-center-people-ts/src/modules/people.ts:145

If true, fall back to name-based search when email/phone search fails. Requires both firstName and lastName to be provided. Uses contact validation to avoid wrong-person matches. (default: false)

contactValidation?

optional contactValidation: "strict" | "domain" | "similarity"

Defined in: packages/planning-center-people-ts/src/modules/people.ts:152

Contact validation strategy for name-based search fallback:

‘strict’: Requires exact email or phone match
‘domain’: Requires matching email domain or similar phone
‘similarity’: Uses domain matching for email, similarity for phone (default)