---
title: "People reference"
description: "Planning Center People in Planning Center Kit: People, households, lists, forms, workflows, notes, and custom fields."
---

> 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.

# People reference

People, households, lists, forms, workflows, notes, and custom fields.

| Property | Value |
| --- | --- |
| Client property | `pco.people` |
| Subpath import | `import { createPeopleClient } from '@mackenly/planningcenterkit/people'` |
| Types namespace | `People` |
| Base path | `/people/v2` |
| Pinned API version | `2026-10-05` |
| Resource types | 67 |
| Planning Center docs | [Planning Center People API](https://api.planningcenteronline.com/docs/apps/people/versions/2026-10-05) |

Each product client sends `X-PCO-API-Version: 2026-10-05`, the version these types were generated from. Override it with `new PlanningCenter({ auth, versions: { people: '...' } })`; the types won't follow. See [Products](/guides/products/).

```ts
import { createPeopleClient } from '@mackenly/planningcenterkit/people';

const people = createPeopleClient({ auth: { applicationId: process.env.PCO_APP_ID!, secret: process.env.PCO_SECRET! } });
const { data: root } = await people.get(); // /people/v2
```

## Root collections

Properties on `pco.people`, named after their URL. `pco.people.get()` fetches the product root (`/people/v2`), and `pco.people.edge(name)` follows any root edge by name.

| Client path | Resource | Returns | Filters | Create |
| --- | --- | --- | --- | --- |
| `pco.people.addresses` | [Address](/reference/people/address/) | Collection |  | No |
| `pco.people.apps` | [App](/reference/people/app/) | Collection |  | No |
| `pco.people.background_checks` | [BackgroundCheck](/reference/people/background-check/) | Collection | `awaiting_applicant`, `canceled`, `complete_clear`, `complete_not_clear`, `current`, `expired`, `expired_invitation`, `needs_review`, `not_expired`, `report_processing` | No |
| `pco.people.birthday_people` | [BirthdayPeople](/reference/people/birthday-people/) | Collection |  | No |
| `pco.people.campuses` | [Campus](/reference/people/campus/) | Collection |  | Yes |
| `pco.people.carriers` | [Carrier](/reference/people/carrier/) | Collection |  | No |
| `pco.people.emails` | [Email](/reference/people/email/) | Collection |  | No |
| `pco.people.field_data` | [FieldDatum](/reference/people/field-datum/) | Collection |  | No |
| `pco.people.field_definitions` | [FieldDefinition](/reference/people/field-definition/) | Collection | `include_deleted` | No |
| `pco.people.form_categories` | [FormCategory](/reference/people/form-category/) | Collection |  | Yes |
| `pco.people.forms` | [Form](/reference/people/form/) | Collection | `archived`, `closed`, `has_active_automations`, `not_archived`, `open`, `recently_deleted`, `recently_viewed`, `unassigned`, `with_recoverable` | No |
| `pco.people.households` | [Household](/reference/people/household/) | Collection |  | Yes |
| `pco.people.inactive_reasons` | [InactiveReason](/reference/people/inactive-reason/) | Collection |  | Yes |
| `pco.people.list_categories` | [ListCategory](/reference/people/list-category/) | Collection |  | Yes |
| `pco.people.lists` | [List](/reference/people/list/) | Collection | `auto_refresh_enabled`, `can_manage`, `has_active_automations`, `mailchimp_connected`, `needs_attention`, `recently_viewed`, `starred`, `unassigned` | No |
| `pco.people.marital_statuses` | [MaritalStatus](/reference/people/marital-status/) | Collection |  | Yes |
| `pco.people.me` | [Person](/reference/people/person/) | Single resource |  | No |
| `pco.people.membership_types` | [MembershipType](/reference/people/membership-type/) | Collection |  | Yes |
| `pco.people.message_groups` | [MessageGroup](/reference/people/message-group/) | Collection |  | No |
| `pco.people.messages` | [Message](/reference/people/message/) | Collection | `created_after` | No |
| `pco.people.name_prefixes` | [NamePrefix](/reference/people/name-prefix/) | Collection |  | Yes |
| `pco.people.name_suffixes` | [NameSuffix](/reference/people/name-suffix/) | Collection |  | Yes |
| `pco.people.note_categories` | [NoteCategory](/reference/people/note-category/) | Collection | `view_creatable` | Yes |
| `pco.people.note_category_subscriptions` | [NoteCategorySubscription](/reference/people/note-category-subscription/) | Collection |  | No |
| `pco.people.notes` | [Note](/reference/people/note/) | Collection |  | No |
| `pco.people.people` | [Person](/reference/people/person/) | Collection | `admins`, `created_since`, `organization_admins` | Yes |
| `pco.people.people_imports` | [PeopleImport](/reference/people/people-import/) | Collection |  | No |
| `pco.people.person_mergers` | [PersonMerger](/reference/people/person-merger/) | Collection |  | No |
| `pco.people.phone_numbers` | [PhoneNumber](/reference/people/phone-number/) | Collection |  | No |
| `pco.people.reports` | [Report](/reference/people/report/) | Collection |  | Yes |
| `pco.people.school_options` | [SchoolOption](/reference/people/school-option/) | Collection |  | Yes |
| `pco.people.social_profiles` | [SocialProfile](/reference/people/social-profile/) | Collection |  | No |
| `pco.people.spam_email_addresses` | [SpamEmailAddress](/reference/people/spam-email-address/) | Collection |  | No |
| `pco.people.stats` | [OrganizationStatistics](/reference/people/organization-statistics/) | Collection |  | No |
| `pco.people.tabs` | [Tab](/reference/people/tab/) | Collection | `with_field_definitions` | Yes |
| `pco.people.workflow_assignee_summaries` | [WorkflowAssigneeSummary](/reference/people/workflow-assignee-summary/) | Collection |  | No |
| `pco.people.workflows` | [Workflow](/reference/people/workflow/) | Collection | `archived`, `has_active_automations`, `has_my_cards`, `manage_cards_allowed`, `needs_attention`, `not_archived`, `only_deleted`, `recently_deleted`, `recently_viewed`, `unassigned`, `with_deleted`, `with_recoverable`, `with_steps` | Yes |

## Resources

| Resource | TypeScript | Description |
| --- | --- | --- |
| [Address](/reference/people/address/) | `People.Address` | An address represents a physical and/or mailing address for a person. |
| [App](/reference/people/app/) | `People.App` | An app is one of the handful of apps that Planning Center offers that organizations can subscribe to, e.g. |
| [BackgroundCheck](/reference/people/background-check/) | `People.BackgroundCheck` | Background Checks for a Person |
| [BirthdayPeople](/reference/people/birthday-people/) | `People.BirthdayPeople` | Returns upcoming birthdays for the organization. |
| [Campus](/reference/people/campus/) | `People.Campus` | A Campus is a location belonging to an Organization |
| [Carrier](/reference/people/carrier/) | `People.Carrier` |  |
| [Condition](/reference/people/condition/) | `People.Condition` | A condition is an individual criterion used by a List Rule. |
| [ConnectedPerson](/reference/people/connected-person/) | `People.ConnectedPerson` | A Connected Person is an account from a different organization linked to an account in this organization. |
| [CustomSender](/reference/people/custom-sender/) | `People.CustomSender` | A custom sender that can be used when sending emails. |
| [Email](/reference/people/email/) | `People.Email` | An email represents an email address and location. |
| [FieldDatum](/reference/people/field-datum/) | `People.FieldDatum` | A field datum is an individual piece of data for a custom field. |
| [FieldDefinition](/reference/people/field-definition/) | `People.FieldDefinition` | A field definition represents a custom field -- its name, data type, etc. |
| [FieldOption](/reference/people/field-option/) | `People.FieldOption` | A field option represents an individual option for a custom field of type "select" or "checkboxes". |
| [Form](/reference/people/form/) | `People.Form` | A custom form for people to fill out. |
| [FormCategory](/reference/people/form-category/) | `People.FormCategory` | A Form Category |
| [FormField](/reference/people/form-field/) | `People.FormField` | A field in a custom form. |
| [FormFieldCondition](/reference/people/form-field-condition/) | `People.FormFieldCondition` | A rule that conditionally shows a form field based on the answer given to another (trigger) field. |
| [FormFieldOption](/reference/people/form-field-option/) | `People.FormFieldOption` | A field option on a custom form field. |
| [FormSubmission](/reference/people/form-submission/) | `People.FormSubmission` | A form submission represents a single completed entry submitted through a Planning Center form. |
| [FormSubmissionValue](/reference/people/form-submission-value/) | `People.FormSubmissionValue` | A single answer to a single field within a form submission. |
| [Grade](/reference/people/grade/) | `People.Grade` |  |
| [Household](/reference/people/household/) | `People.Household` | A household links people together and can have a primary contact. |
| [HouseholdMembership](/reference/people/household-membership/) | `People.HouseholdMembership` | A household membership is the linking record between a household and a person. |
| [InactiveReason](/reference/people/inactive-reason/) | `People.InactiveReason` | An inactive reason is a small bit of text indicating why a member is no longer active. |
| [List](/reference/people/list/) | `People.List` | A list is a powerful tool for finding and grouping people together using any criteria imaginable. |
| [ListCategory](/reference/people/list-category/) | `People.ListCategory` | A List Category |
| [ListResult](/reference/people/list-result/) | `People.ListResult` | A list result |
| [ListShare](/reference/people/list-share/) | `People.ListShare` | A list share indicates who has access to edit a list. |
| [ListStar](/reference/people/list-star/) | `People.ListStar` | A starred list for a person indicates it is special in some way |
| [MailchimpSyncStatus](/reference/people/mailchimp-sync-status/) | `People.MailchimpSyncStatus` | The status of syncing a List with Mailchimp. |
| [MaritalStatus](/reference/people/marital-status/) | `People.MaritalStatus` | A martial status represents a member's current status, e.g. |
| [MembershipType](/reference/people/membership-type/) | `People.MembershipType` | A profile's membership type, e.g. |
| [Message](/reference/people/message/) | `People.Message` | A message is an individual email or sms text sent to a member. |
| [MessageGroup](/reference/people/message-group/) | `People.MessageGroup` | A message group represents one or more emails or text messages sent from one of the Planning Center apps. |
| [NamePrefix](/reference/people/name-prefix/) | `People.NamePrefix` | A name prefix is one of Mr., Mrs., etc. |
| [NameSuffix](/reference/people/name-suffix/) | `People.NameSuffix` | A name suffix is one of Sr., Jr., etc. |
| [Note](/reference/people/note/) | `People.Note` | A note is text with a category connected to a person’s profile. |
| [NoteCategory](/reference/people/note-category/) | `People.NoteCategory` | A Note Category |
| [NoteCategoryShare](/reference/people/note-category-share/) | `People.NoteCategoryShare` | A note category share defines who can view notes in a category. |
| [NoteCategorySubscription](/reference/people/note-category-subscription/) | `People.NoteCategorySubscription` | A subscription for note categories |
| [Organization](/reference/people/organization/) | `People.Organization` | The organization represents a single church. |
| [OrganizationStatistics](/reference/people/organization-statistics/) | `People.OrganizationStatistics` | Returns statistics for the organization. |
| [PeopleImport](/reference/people/people-import/) | `People.PeopleImport` | A PeopleImport is a record of an ongoing or previous import from a CSV file. |
| [PeopleImportConflict](/reference/people/people-import-conflict/) | `People.PeopleImportConflict` | A PeopleImportConflict is a record of change that will occur if the parent PeopleImport is completed. |
| [PeopleImportHistory](/reference/people/people-import-history/) | `People.PeopleImportHistory` | A PeopleImportHistory is a record of change that occurred when the parent PeopleImport was completed. |
| [Person](/reference/people/person/) | `People.Person` | A person record represents a single member/user of the application. |
| [PersonApp](/reference/people/person-app/) | `People.PersonApp` | A Person App is the relationship between a Person and an App. |
| [PersonMerger](/reference/people/person-merger/) | `People.PersonMerger` | A Person Merger is the history of profiles that were merged into other profiles. |
| [PhoneNumber](/reference/people/phone-number/) | `People.PhoneNumber` | A phone number represents a single telephone number and location. |
| [PlatformNotification](/reference/people/platform-notification/) | `People.PlatformNotification` | A Platform Notification is a suite-wide notification that shows at the top of each application's screen until dismissed by the user. |
| [Report](/reference/people/report/) | `People.Report` | A report is editable liquid syntax that provides a powerful tool for presenting your Lists however you want. |
| [Rule](/reference/people/rule/) | `People.Rule` | A rule belongs to a List and groups conditions together. |
| [SchoolOption](/reference/people/school-option/) | `People.SchoolOption` | A school option represents a school name, school type, grades, etc. |
| [ServiceTime](/reference/people/service-time/) | `People.ServiceTime` | A ServiceTime Resource |
| [SocialProfile](/reference/people/social-profile/) | `People.SocialProfile` | A social profile represents a members's Twitter, Facebook, or other social media account. |
| [SpamEmailAddress](/reference/people/spam-email-address/) | `People.SpamEmailAddress` | An email address that is marked as spam |
| [Tab](/reference/people/tab/) | `People.Tab` | A tab is a custom tab and groups like field definitions. |
| [Workflow](/reference/people/workflow/) | `People.Workflow` | A Workflow |
| [WorkflowAssigneeSummary](/reference/people/workflow-assignee-summary/) | `People.WorkflowAssigneeSummary` | Aggregated card counts for an assignee across all visible workflows |
| [WorkflowAssigneeWorkflowSummary](/reference/people/workflow-assignee-workflow-summary/) | `People.WorkflowAssigneeWorkflowSummary` | Per-workflow card counts for a specific assignee |
| [WorkflowCard](/reference/people/workflow-card/) | `People.WorkflowCard` | A Card |
| [WorkflowCardActivity](/reference/people/workflow-card-activity/) | `People.WorkflowCardActivity` | Workflow Card Activity is a record of an action performed on a card |
| [WorkflowCardNote](/reference/people/workflow-card-note/) | `People.WorkflowCardNote` | Workflow Note is a note that has been made on a Workflow Card |
| [WorkflowCategory](/reference/people/workflow-category/) | `People.WorkflowCategory` | A Workflow Category |
| [WorkflowShare](/reference/people/workflow-share/) | `People.WorkflowShare` | A workflow share defines who can access a workflow. |
| [WorkflowStep](/reference/people/workflow-step/) | `People.WorkflowStep` | A Step |
| [WorkflowStepAssigneeSummary](/reference/people/workflow-step-assignee-summary/) | `People.WorkflowStepAssigneeSummary` | The ready and snoozed count for an assignee & step |

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