---
title: "PeopleImport (People)"
description: "A PeopleImport is a record of an ongoing or previous import from a CSV file."
---

> Documentation Index
> Fetch the complete documentation index at: https://planningcenterkit.mackenly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PeopleImport (People)

A PeopleImport is a record of an ongoing or previous import from a CSV file.

| Property | Value |
| --- | --- |
| Product | [People](/reference/people/) (`pco.people`, API version `2026-10-05`) |
| Resource type | `PeopleImport` |
| TypeScript | `People.PeopleImport`, attributes `People.PeopleImportAttributes`, schema `People.PeopleImportSchema` |
| Planning Center path | `/people/v2/people_imports` |
| Planning Center docs | [PeopleImport](https://api.planningcenteronline.com/docs/apps/people/versions/2026-10-05/vertices/people_import) |

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.people.people_imports` | Collection |  | No |

From a collection, `.id(peopleImportId)` addresses one PeopleImport: `pco.people.people_imports.id(peopleImportId)`. Collections support [`where`, `include`, `order`, and pagination](/guides/querying/); single resources have `get()`.

## Attributes

On `People.PeopleImportAttributes`. Every resource also has `id` and `type` (`'PeopleImport'`) next to its attributes.

| Name | Type | Description |
| --- | --- | --- |
| `attribs` | `string \| null` |  |
| `created_at` | `string \| null` |  |
| `processed_at` | `string \| null` |  |
| `status` | `string \| null` | Possible values: `matching`, `processing_preview`, `previewing`, `processing_import`, `complete`, `undone`, or `undoing` |
| `undone_at` | `string \| null` |  |
| `updated_at` | `string \| null` |  |

## Relationships and includes

Planning Center documents no includes for this resource.

| Relationship | Type | To | Includable |
| --- | --- | --- | --- |
| `created_by` | To one | [Person](/reference/people/person/) | No |
| `undone_by` | To one | [Person](/reference/people/person/) | No |

## Querying

### Where

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

| Field | Value type | Operators |
| --- | --- | --- |
| `status` | `string` | Equality only |

No documented `order` fields.

## Edges

Follow these from one PeopleImport, `ref = pco.people.people_imports.id(peopleImportId)`:

| Edge | Leads to | Returns | Filters | Create |
| --- | --- | --- | --- | --- |
| `ref.conflicts` | [PeopleImportConflict](/reference/people/people-import-conflict/) | Collection | `creates`, `creates_and_updates`, `errors`, `household_creates`, `household_updates`, `identical`, `ignored`, `not_ignored`, `updates` | No |
| `ref.histories` | [PeopleImportHistory](/reference/people/people-import-history/) | Collection | `creates`, `household_creates`, `household_updates`, `identical`, `updates` | No |

## Writing

| Property | Value |
| --- | --- |
| Create | No |
| Update | No |
| Delete | No |

## Example

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

const page = await pco.people.people_imports.perPage(25).list();
const items: People.PeopleImport[] = page.data;
```

Source: https://planningcenterkit.mackenly.com/reference/people/people-import/index.mdx
