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 |
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.
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/v2Root 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 | Collection | No | |
pco.people.apps |
App | Collection | No | |
pco.people.background_checks |
BackgroundCheck | 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 | Collection | No | |
pco.people.campuses |
Campus | Collection | Yes | |
pco.people.carriers |
Carrier | Collection | No | |
pco.people.emails |
Collection | No | ||
pco.people.field_data |
FieldDatum | Collection | No | |
pco.people.field_definitions |
FieldDefinition | Collection | include_deleted |
No |
pco.people.form_categories |
FormCategory | Collection | Yes | |
pco.people.forms |
Form | Collection | archived, closed, has_active_automations, not_archived, open, recently_deleted, recently_viewed, unassigned, with_recoverable |
No |
pco.people.households |
Household | Collection | Yes | |
pco.people.inactive_reasons |
InactiveReason | Collection | Yes | |
pco.people.list_categories |
ListCategory | Collection | Yes | |
pco.people.lists |
List | Collection | auto_refresh_enabled, can_manage, has_active_automations, mailchimp_connected, needs_attention, recently_viewed, starred, unassigned |
No |
pco.people.marital_statuses |
MaritalStatus | Collection | Yes | |
pco.people.me |
Person | Single resource | No | |
pco.people.membership_types |
MembershipType | Collection | Yes | |
pco.people.message_groups |
MessageGroup | Collection | No | |
pco.people.messages |
Message | Collection | created_after |
No |
pco.people.name_prefixes |
NamePrefix | Collection | Yes | |
pco.people.name_suffixes |
NameSuffix | Collection | Yes | |
pco.people.note_categories |
NoteCategory | Collection | view_creatable |
Yes |
pco.people.note_category_subscriptions |
NoteCategorySubscription | Collection | No | |
pco.people.notes |
Note | Collection | No | |
pco.people.people |
Person | Collection | admins, created_since, organization_admins |
Yes |
pco.people.people_imports |
PeopleImport | Collection | No | |
pco.people.person_mergers |
PersonMerger | Collection | No | |
pco.people.phone_numbers |
PhoneNumber | Collection | No | |
pco.people.reports |
Report | Collection | Yes | |
pco.people.school_options |
SchoolOption | Collection | Yes | |
pco.people.social_profiles |
SocialProfile | Collection | No | |
pco.people.spam_email_addresses |
SpamEmailAddress | Collection | No | |
pco.people.stats |
OrganizationStatistics | Collection | No | |
pco.people.tabs |
Tab | Collection | with_field_definitions |
Yes |
pco.people.workflow_assignee_summaries |
WorkflowAssigneeSummary | Collection | No | |
pco.people.workflows |
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 | People.Address |
An address represents a physical and/or mailing address for a person. |
| App | People.App |
An app is one of the handful of apps that Planning Center offers that organizations can subscribe to, e.g. |
| BackgroundCheck | People.BackgroundCheck |
Background Checks for a Person |
| BirthdayPeople | People.BirthdayPeople |
Returns upcoming birthdays for the organization. |
| Campus | People.Campus |
A Campus is a location belonging to an Organization |
| Carrier | People.Carrier |
|
| Condition | People.Condition |
A condition is an individual criterion used by a List Rule. |
| ConnectedPerson | People.ConnectedPerson |
A Connected Person is an account from a different organization linked to an account in this organization. |
| CustomSender | People.CustomSender |
A custom sender that can be used when sending emails. |
People.Email |
An email represents an email address and location. | |
| FieldDatum | People.FieldDatum |
A field datum is an individual piece of data for a custom field. |
| FieldDefinition | People.FieldDefinition |
A field definition represents a custom field – its name, data type, etc. |
| FieldOption | People.FieldOption |
A field option represents an individual option for a custom field of type “select” or “checkboxes”. |
| Form | People.Form |
A custom form for people to fill out. |
| FormCategory | People.FormCategory |
A Form Category |
| FormField | People.FormField |
A field in a custom form. |
| FormFieldCondition | People.FormFieldCondition |
A rule that conditionally shows a form field based on the answer given to another (trigger) field. |
| FormFieldOption | People.FormFieldOption |
A field option on a custom form field. |
| FormSubmission | People.FormSubmission |
A form submission represents a single completed entry submitted through a Planning Center form. |
| FormSubmissionValue | People.FormSubmissionValue |
A single answer to a single field within a form submission. |
| Grade | People.Grade |
|
| Household | People.Household |
A household links people together and can have a primary contact. |
| HouseholdMembership | People.HouseholdMembership |
A household membership is the linking record between a household and a person. |
| InactiveReason | People.InactiveReason |
An inactive reason is a small bit of text indicating why a member is no longer active. |
| List | People.List |
A list is a powerful tool for finding and grouping people together using any criteria imaginable. |
| ListCategory | People.ListCategory |
A List Category |
| ListResult | People.ListResult |
A list result |
| ListShare | People.ListShare |
A list share indicates who has access to edit a list. |
| ListStar | People.ListStar |
A starred list for a person indicates it is special in some way |
| MailchimpSyncStatus | People.MailchimpSyncStatus |
The status of syncing a List with Mailchimp. |
| MaritalStatus | People.MaritalStatus |
A martial status represents a member’s current status, e.g. |
| MembershipType | People.MembershipType |
A profile’s membership type, e.g. |
| Message | People.Message |
A message is an individual email or sms text sent to a member. |
| MessageGroup | People.MessageGroup |
A message group represents one or more emails or text messages sent from one of the Planning Center apps. |
| NamePrefix | People.NamePrefix |
A name prefix is one of Mr., Mrs., etc. |
| NameSuffix | People.NameSuffix |
A name suffix is one of Sr., Jr., etc. |
| Note | People.Note |
A note is text with a category connected to a person’s profile. |
| NoteCategory | People.NoteCategory |
A Note Category |
| NoteCategoryShare | People.NoteCategoryShare |
A note category share defines who can view notes in a category. |
| NoteCategorySubscription | People.NoteCategorySubscription |
A subscription for note categories |
| Organization | People.Organization |
The organization represents a single church. |
| OrganizationStatistics | People.OrganizationStatistics |
Returns statistics for the organization. |
| PeopleImport | People.PeopleImport |
A PeopleImport is a record of an ongoing or previous import from a CSV file. |
| PeopleImportConflict | People.PeopleImportConflict |
A PeopleImportConflict is a record of change that will occur if the parent PeopleImport is completed. |
| PeopleImportHistory | People.PeopleImportHistory |
A PeopleImportHistory is a record of change that occurred when the parent PeopleImport was completed. |
| Person | People.Person |
A person record represents a single member/user of the application. |
| PersonApp | People.PersonApp |
A Person App is the relationship between a Person and an App. |
| PersonMerger | People.PersonMerger |
A Person Merger is the history of profiles that were merged into other profiles. |
| PhoneNumber | People.PhoneNumber |
A phone number represents a single telephone number and location. |
| PlatformNotification | 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 | People.Report |
A report is editable liquid syntax that provides a powerful tool for presenting your Lists however you want. |
| Rule | People.Rule |
A rule belongs to a List and groups conditions together. |
| SchoolOption | People.SchoolOption |
A school option represents a school name, school type, grades, etc. |
| ServiceTime | People.ServiceTime |
A ServiceTime Resource |
| SocialProfile | People.SocialProfile |
A social profile represents a members’s Twitter, Facebook, or other social media account. |
| SpamEmailAddress | People.SpamEmailAddress |
An email address that is marked as spam |
| Tab | People.Tab |
A tab is a custom tab and groups like field definitions. |
| Workflow | People.Workflow |
A Workflow |
| WorkflowAssigneeSummary | People.WorkflowAssigneeSummary |
Aggregated card counts for an assignee across all visible workflows |
| WorkflowAssigneeWorkflowSummary | People.WorkflowAssigneeWorkflowSummary |
Per-workflow card counts for a specific assignee |
| WorkflowCard | People.WorkflowCard |
A Card |
| WorkflowCardActivity | People.WorkflowCardActivity |
Workflow Card Activity is a record of an action performed on a card |
| WorkflowCardNote | People.WorkflowCardNote |
Workflow Note is a note that has been made on a Workflow Card |
| WorkflowCategory | People.WorkflowCategory |
A Workflow Category |
| WorkflowShare | People.WorkflowShare |
A workflow share defines who can access a workflow. |
| WorkflowStep | People.WorkflowStep |
A Step |
| WorkflowStepAssigneeSummary | People.WorkflowStepAssigneeSummary |
The ready and snoozed count for an assignee & step |