---
title: "Person (People)"
description: "A person record represents a single member/user of the application."
---

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

# Person (People)

A person record represents a single member/user of the application. Each person has different permissions that determine how the user can use this app (if at all).

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

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.people.me` | Single resource |  | No |
| `pco.people.people` | Collection | `admins`, `created_since`, `organization_admins` | Yes |
| `pco.people.background_checks.id(backgroundCheckId).created_by` | Collection |  | No |
| `pco.people.background_checks.id(backgroundCheckId).person` | Collection |  | No |
| `pco.people.lists.id(listId).rules.id(ruleId).conditions.id(conditionId).created_by` | Collection |  | No |
| `pco.people.emails.id(emailId).person` | Collection |  | No |
| `pco.people.field_data.id(fieldDatumId).person` | Collection |  | No |
| `pco.people.forms.id(formId).form_submissions.id(formSubmissionId).person` | Collection |  | No |
| `pco.people.households.id(householdId).people` | Collection | `non_pending`, `without_deceased` | No |
| `pco.people.households.id(householdId).household_memberships.id(householdMembershipId).person` | Collection |  | No |
| `pco.people.lists.id(listId).created_by` | Collection |  | No |
| `pco.people.lists.id(listId).people` | Collection |  | No |
| `pco.people.lists.id(listId).updated_by` | Collection |  | No |
| `pco.people.lists.id(listId).list_results.id(listResultId).person` | Collection |  | No |
| `pco.people.lists.id(listId).shares.id(listShareId).person` | Collection |  | No |
| `pco.people.messages.id(messageId).to` | Collection |  | No |
| `pco.people.message_groups.id(messageGroupId).from` | Collection |  | No |
| `pco.people.notes.id(noteId).created_by` | Collection |  | No |
| `pco.people.notes.id(noteId).person` | Collection |  | No |
| `pco.people.note_categories.id(noteCategoryId).subscribers` | Collection |  | No |
| `pco.people.note_categories.id(noteCategoryId).shares.id(noteCategoryShareId).person` | Collection |  | No |
| `pco.people.note_category_subscriptions.id(noteCategorySubscriptionId).person` | Collection |  | No |
| `pco.people.people_imports.id(peopleImportId).histories.id(peopleImportHistoryId).person` | Collection |  | No |
| `pco.people.reports.id(reportId).created_by` | Collection |  | No |
| `pco.people.reports.id(reportId).updated_by` | Collection |  | No |
| `pco.people.social_profiles.id(socialProfileId).person` | Collection |  | No |
| `pco.people.workflows.id(workflowId).shared_people` | Collection |  | No |
| `pco.people.people.id(personId).workflow_cards.id(workflowCardId).assignee` | Collection |  | No |
| `pco.people.people.id(personId).workflow_cards.id(workflowCardId).person` | Collection |  | No |
| `pco.people.people.id(personId).workflow_shares.id(workflowShareId).person` | Collection |  | No |
| `pco.people.workflows.id(workflowId).steps.id(workflowStepId).default_assignee` | Collection |  | No |
| `pco.people.workflows.id(workflowId).steps.id(workflowStepId).assignee_summaries.id(workflowStepAssigneeSummaryId).person` | Collection |  | No |

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

## Attributes

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

| Name | Type | Description |
| --- | --- | --- |
| `accounting_administrator` | `boolean \| null` |  |
| `anniversary` | `string \| null` |  |
| `avatar` | `string \| null` | File UUID (see [File Uploads](#file-uploads) section) |
| `birthdate` | `string \| null` |  |
| `can_create_forms` | `boolean \| null` |  |
| `can_email_lists` | `boolean \| null` |  |
| `child` | `boolean \| null` |  |
| `created_at` | `string \| null` |  |
| `demographic_avatar_url` | `string \| null` |  |
| `directory_shared_info` | `Record<string, unknown> \| null` | Only available when requested with the `?fields` param |
| `directory_status` | `string \| null` |  |
| `first_name` | `string \| null` |  |
| `gender` | `string \| null` |  |
| `given_name` | `string \| null` |  |
| `grade` | `number \| null` |  |
| `graduation_year` | `number \| null` |  |
| `inactivated_at` | `string \| null` | Set to an ISO 8601 date or time to make the profile inactive. Set to "null" to reactivate the profile. |
| `last_name` | `string \| null` |  |
| `login_identifier` | `string \| null` |  |
| `medical_notes` | `string \| null` |  |
| `membership` | `string \| null` |  |
| `mfa_configured` | `boolean \| null` | Only available when requested with the `?fields` param Set to "true" or "false" to filter. Can only be viewed and queried by an Organization Administrator. |
| `middle_name` | `string \| null` |  |
| `name` | `string \| null` |  |
| `nickname` | `string \| null` |  |
| `passed_background_check` | `boolean \| null` |  |
| `people_permissions` | `string \| null` |  |
| `remote_id` | `number \| null` |  |
| `school_type` | `string \| null` |  |
| `selective_access` | `boolean \| null` |  |
| `site_administrator` | `boolean \| null` |  |
| `status` | `string \| null` | Set to "inactive" to set "inactivated_at" to the current time and make the profile inactive. Set to anything else to clear "inactivated_at" and reactivate the profile. |
| `stripe_account_identifier` | `string \| null` | Only available when requested with the `?fields` param |
| `stripe_customer_identifier` | `string \| null` | Only available when requested with the `?fields` param |
| `updated_at` | `string \| null` |  |

## Relationships and includes

Side-load with `include()` (or `get({ include })`) and read with `related(resource, name)`: `addresses`, `emails`, `field_data`, `households`, `inactive_reason`, `marital_status`, `name_prefix`, `name_suffix`, `organization`, `person_apps`, `phone_numbers`, `platform_notifications`, `primary_campus`, `school`, `social_profiles`.

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

## Querying

### Where

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

| Field | Value type | Operators |
| --- | --- | --- |
| `accounting_administrator` | `boolean` | Equality only |
| `anniversary` | `string \| Date` | `gt`, `gte`, `lt`, `lte` |
| `birthdate` | `string \| Date` | `gt`, `gte`, `lt`, `lte` |
| `child` | `boolean` | Equality only |
| `created_at` | `string \| Date` | `gt`, `gte`, `lt`, `lte` |
| `first_name` | `string` | Equality only |
| `gender` | `string` | Equality only |
| `given_name` | `string` | Equality only |
| `grade` | `number` | Equality only |
| `graduation_year` | `number` | Equality only |
| `id` | `string` | Equality only |
| `inactivated_at` | `string \| Date` | `gt`, `gte`, `lt`, `lte` |
| `last_name` | `string` | Equality only |
| `medical_notes` | `string` | Equality only |
| `membership` | `string` | Equality only |
| `mfa_configured` | `boolean` | Equality only |
| `middle_name` | `string` | Equality only |
| `nickname` | `string` | Equality only |
| `people_permissions` | `string` | Equality only |
| `primary_campus_id` | `string \| number` | Equality only |
| `remote_id` | `string \| number` | Equality only |
| `search_name` | `string` | Equality only |
| `search_name_or_email` | `string` | Equality only |
| `search_name_or_email_or_phone_number` | `string` | Equality only |
| `search_phone_number` | `string` | Equality only |
| `search_phone_number_e164` | `string` | Equality only |
| `site_administrator` | `boolean` | Equality only |
| `status` | `string` | Equality only |
| `updated_at` | `string \| Date` | `gt`, `gte`, `lt`, `lte` |

### Order

`order(...)` accepts these fields, ascending, or descending with a `-` prefix: `accounting_administrator`, `anniversary`, `birthdate`, `child`, `created_at`, `first_name`, `gender`, `given_name`, `grade`, `graduation_year`, `inactivated_at`, `last_name`, `membership`, `middle_name`, `nickname`, `people_permissions`, `remote_id`, `site_administrator`, `status`, `updated_at`.

### Filters

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

| Edge | Filters |
| --- | --- |
| `pco.people.people` | `admins`, `created_since`, `organization_admins` |
| `people` on [Household](/reference/people/household/) | `non_pending`, `without_deceased` |

## Edges

Follow these from one Person, `ref = pco.people.people.id(personId)`:

| Edge | Leads to | Returns | Filters | Create |
| --- | --- | --- | --- | --- |
| `ref.addresses` | [Address](/reference/people/address/) | Collection |  | Yes |
| `ref.apps` | [App](/reference/people/app/) | Collection |  | No |
| `ref.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` | Yes |
| `ref.connected_people` | [ConnectedPerson](/reference/people/connected-person/) | Collection |  | No |
| `ref.emails` | [Email](/reference/people/email/) | Collection |  | Yes |
| `ref.field_data` | [FieldDatum](/reference/people/field-datum/) | Collection |  | Yes |
| `ref.household_memberships` | [HouseholdMembership](/reference/people/household-membership/) | Collection |  | No |
| `ref.households` | [Household](/reference/people/household/) | Collection |  | No |
| `ref.inactive_reason` | [InactiveReason](/reference/people/inactive-reason/) | Collection |  | No |
| `ref.marital_status` | [MaritalStatus](/reference/people/marital-status/) | Collection |  | No |
| `ref.message_groups` | [MessageGroup](/reference/people/message-group/) | Collection |  | No |
| `ref.messages` | [Message](/reference/people/message/) | Collection | `created_after`, `received`, `sent`, `unread` | No |
| `ref.name_prefix` | [NamePrefix](/reference/people/name-prefix/) | Collection |  | No |
| `ref.name_suffix` | [NameSuffix](/reference/people/name-suffix/) | Collection |  | No |
| `ref.notes` | [Note](/reference/people/note/) | Collection |  | Yes |
| `ref.organization` | [Organization](/reference/people/organization/) | Collection |  | No |
| `ref.person_apps` | [PersonApp](/reference/people/person-app/) | Collection |  | Yes |
| `ref.phone_numbers` | [PhoneNumber](/reference/people/phone-number/) | Collection |  | Yes |
| `ref.platform_notifications` | [PlatformNotification](/reference/people/platform-notification/) | Collection |  | No |
| `ref.primary_campus` | [Campus](/reference/people/campus/) | Collection |  | No |
| `ref.school` | [SchoolOption](/reference/people/school-option/) | Collection |  | No |
| `ref.social_profiles` | [SocialProfile](/reference/people/social-profile/) | Collection |  | Yes |
| `ref.workflow_assignee_workflow_summaries` | [WorkflowAssigneeWorkflowSummary](/reference/people/workflow-assignee-workflow-summary/) | Collection |  | No |
| `ref.workflow_cards` | [WorkflowCard](/reference/people/workflow-card/) | Collection | `assigned` | No |
| `ref.workflow_shares` | [WorkflowShare](/reference/people/workflow-share/) | Collection |  | No |

## Writing

| Property | Value |
| --- | --- |
| Create | Yes, `create()` on `pco.people.people` |
| Update | Yes, `update()` on a reference |
| Delete | Yes, `delete()` on a reference |

### Create attributes

Typed as `People.PersonSchema['create']`.

| Attribute | Type |
| --- | --- |
| `accounting_administrator` | `boolean \| null` |
| `anniversary` | `string \| null` |
| `avatar` | `string \| null` |
| `birthdate` | `string \| null` |
| `child` | `boolean \| null` |
| `created_by_id` | `string` |
| `first_name` | `string \| null` |
| `gender` | `string \| null` |
| `gender_id` | `string` |
| `given_name` | `string \| null` |
| `grade` | `number \| null` |
| `graduation_year` | `number \| null` |
| `in_app` | `unknown` |
| `inactivated_at` | `string \| null` |
| `inactive_reason_id` | `string` |
| `last_name` | `string \| null` |
| `marital_status_id` | `string` |
| `medical_notes` | `string \| null` |
| `membership` | `string \| null` |
| `membership_status_id` | `string` |
| `middle_name` | `string \| null` |
| `name_prefix` | `unknown` |
| `name_prefix_id` | `string` |
| `name_suffix` | `unknown` |
| `name_suffix_id` | `string` |
| `nickname` | `string \| null` |
| `people_permissions` | `string \| null` |
| `primary_campus_id` | `string` |
| `remote_id` | `number \| null` |
| `school_id` | `string` |
| `site_administrator` | `boolean \| null` |
| `status` | `string \| null` |
| `stripe_account_identifier` | `string \| null` |
| `stripe_customer_identifier` | `string \| null` |

### Update attributes

Typed as `People.PersonSchema['update']`.

| Attribute | Type |
| --- | --- |
| `accounting_administrator` | `boolean \| null` |
| `anniversary` | `string \| null` |
| `avatar` | `string \| null` |
| `birthdate` | `string \| null` |
| `child` | `boolean \| null` |
| `first_name` | `string \| null` |
| `gender` | `string \| null` |
| `gender_id` | `string` |
| `given_name` | `string \| null` |
| `grade` | `number \| null` |
| `graduation_year` | `number \| null` |
| `inactivated_at` | `string \| null` |
| `inactive_reason_id` | `string` |
| `last_name` | `string \| null` |
| `marital_status_id` | `string` |
| `medical_notes` | `string \| null` |
| `membership` | `string \| null` |
| `membership_status_id` | `string` |
| `middle_name` | `string \| null` |
| `name_prefix` | `unknown` |
| `name_prefix_id` | `string` |
| `name_suffix` | `unknown` |
| `name_suffix_id` | `string` |
| `nickname` | `string \| null` |
| `people_permissions` | `string \| null` |
| `primary_campus_id` | `string` |
| `remote_id` | `number \| null` |
| `school_id` | `string` |
| `site_administrator` | `boolean \| null` |
| `status` | `string \| null` |
| `stripe_account_identifier` | `string \| null` |
| `stripe_customer_identifier` | `string \| null` |

See [Writing data](/guides/writing-data/).

## Example

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

const page = await pco.people.people.order('accounting_administrator').perPage(25).list();
const items: People.Person[] = page.data;
```

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