Skip to content

PeopleImportHistory (People)

A PeopleImportHistory is a record of change that occurred when the parent PeopleImport was completed.

A PeopleImportHistory is a record of change that occurred when the parent PeopleImport was completed.

Property Value
Product People (pco.people, API version 2026-10-05)
Resource type PeopleImportHistory
TypeScript People.PeopleImportHistory, attributes People.PeopleImportHistoryAttributes, schema People.PeopleImportHistorySchema
Planning Center path /people/v2/people_imports/{people_import_id}/histories
Planning Center docs PeopleImportHistory

How to reach it

Client path Returns Filters Create
pco.people.people_imports.id(peopleImportId).histories Collection creates, household_creates, household_updates, identical, updates No

From a collection, .id(peopleImportHistoryId) addresses one PeopleImportHistory: pco.people.people_imports.id(peopleImportId).histories.id(peopleImportHistoryId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On People.PeopleImportHistoryAttributes. Every resource also has id and type ('PeopleImportHistory') next to its attributes.

Name Type Description
conflicting_changes Record<string, unknown> | null
created_at string | null
kind string | null
name string | null
updated_at string | null

Relationships and includes

Side-load with include() (or get({ include })) and read with related(resource, name): household, person.

Querying

Where

where(field, value) for equality; where(field, op, value) with the operators listed.

Field Value type Operators
name string Equality only

No documented order fields.

Filters

filter(...) names depend on the edge you query through:

Edge Filters
histories on PeopleImport creates, household_creates, household_updates, identical, updates

Edges

Follow these from one PeopleImportHistory, ref = pco.people.people_imports.id(peopleImportId).histories.id(peopleImportHistoryId):

Edge Leads to Returns Filters Create
ref.household Household Collection No
ref.person Person Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

import type { People } from '@mackenly/planningcenterkit';

const peopleImportId = '1'; // PeopleImport id

const page = await pco.people.people_imports.id(peopleImportId).histories.perPage(25).list();
const items: People.PeopleImportHistory[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close