A Person Merger is the history of profiles that were merged into other profiles.
| Property | Value |
|---|---|
| Product | People (pco.people, API version 2026-10-05) |
| Resource type | PersonMerger |
| TypeScript | People.PersonMerger, attributes People.PersonMergerAttributes, schema People.PersonMergerSchema |
| Planning Center path | /people/v2/person_mergers |
| Planning Center docs | PersonMerger |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.people.person_mergers |
Collection | No |
From a collection, .id(personMergerId) addresses one PersonMerger: pco.people.person_mergers.id(personMergerId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On People.PersonMergerAttributes. Every resource also has id and type ('PersonMerger') next to its attributes.
| Name | Type | Description |
|---|---|---|
created_at |
string | null |
|
person_to_keep_id |
number | null |
|
person_to_remove_id |
number | null |
Relationships and includes
Planning Center documents no includes for this resource.
Querying
Where
where(field, value) for equality; where(field, op, value) with the operators listed.
| Field | Value type | Operators |
|---|---|---|
created_at |
string | Date |
gt, gte, lt, lte |
person_to_keep_id |
string | number |
Equality only |
person_to_remove_id |
string | number |
Equality only |
Order
order(...) accepts these fields, ascending, or descending with a - prefix: created_at.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { People } from '@mackenly/planningcenterkit';
const page = await pco.people.person_mergers.order('created_at').perPage(25).list();
const items: People.PersonMerger[] = page.data;