---
title: "PlanPerson (Services)"
description: "A person scheduled within a specific plan."
---

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

# PlanPerson (Services)

A person scheduled within a specific plan.

| Property | Value |
| --- | --- |
| Product | [Services](/reference/services/) (`pco.services`, API version `2018-11-01`) |
| Resource type | `PlanPerson` |
| TypeScript | `Services.PlanPerson`, attributes `Services.PlanPersonAttributes`, schema `Services.PlanPersonSchema` |
| Planning Center path | `/services/v2/people/{person_id}/plan_people` |
| Planning Center docs | [PlanPerson](https://api.planningcenteronline.com/docs/apps/services/versions/2018-11-01/vertices/plan_person) |

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.services.people.id(personId).plan_people` | Collection |  | No |
| `pco.services.series.id(seriesId).plans.id(planId).team_members` | Collection | `confirmed`, `not_archived`, `not_declined`, `not_deleted` | Yes |
| `pco.services.service_types.id(serviceTypeId).plan_templates.id(planTemplateId).team_members` | Collection | `confirmed`, `not_archived`, `not_declined`, `not_deleted` | Yes |

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

## Attributes

On `Services.PlanPersonAttributes`. Every resource also has `id` and `type` (`'PlanPerson'`) next to its attributes.

| Name | Type | Description |
| --- | --- | --- |
| `can_accept_partial` | `boolean \| null` | If the person is scheduled to a split team where they could potentially accept 1 time and decline another. |
| `created_at` | `string \| null` |  |
| `decline_reason` | `string \| null` |  |
| `name` | `string \| null` |  |
| `notes` | `string \| null` |  |
| `notification_changed_at` | `string \| null` |  |
| `notification_changed_by_name` | `string \| null` |  |
| `notification_prepared_at` | `string \| null` |  |
| `notification_read_at` | `string \| null` |  |
| `notification_sender_name` | `string \| null` |  |
| `notification_sent_at` | `string \| null` |  |
| `photo_thumbnail` | `string \| null` |  |
| `prepare_notification` | `boolean \| null` |  |
| `scheduled_by_is_eligible_for_responds_to` | `boolean \| null` | Only available when requested with the `?fields` param |
| `scheduled_by_name` | `string \| null` | Only available when requested with the `?fields` param |
| `status` | `string \| null` | Accepts one of 'C', 'U', 'D', or 'Confirmed', 'Unconfirmed', or 'Declined' |
| `status_updated_at` | `string \| null` |  |
| `team_position_name` | `string \| null` |  |
| `updated_at` | `string \| null` |  |

## Relationships and includes

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

| Relationship | Type | To | Includable |
| --- | --- | --- | --- |
| `person` | To one | [Person](/reference/services/person/) | Yes |
| `plan` | To one | [Plan](/reference/services/plan/) | Yes |
| `responds_to` | To one | [Person](/reference/services/person/) | No |
| `scheduled_by` | To one | [Person](/reference/services/person/) | No |
| `service_times` | To many | [PlanTime](/reference/services/plan-time/) | No |
| `service_type` | To one | [ServiceType](/reference/services/service-type/) | No |
| `team` | To one | [Team](/reference/services/team/) | Yes |
| `time_preference_options` | To many | [TimePreferenceOption](/reference/services/time-preference-option/) | No |
| `times` | To many | [PlanTime](/reference/services/plan-time/) | No |

## Querying

### Where

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

| Field | Value type | Operators |
| --- | --- | --- |
| `team_id` | `string \| number` | Equality only |

No documented `order` fields.

### Filters

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

| Edge | Filters |
| --- | --- |
| `team_members` on [Plan](/reference/services/plan/) | `confirmed`, `not_archived`, `not_declined`, `not_deleted` |
| `team_members` on [PlanTemplate](/reference/services/plan-template/) | `confirmed`, `not_archived`, `not_declined`, `not_deleted` |

## Edges

Follow these from one PlanPerson, `ref = pco.services.people.id(personId).plan_people.id(planPersonId)`:

| Edge | Leads to | Returns | Filters | Create |
| --- | --- | --- | --- | --- |
| `ref.declined_plan_times` | [PlanTime](/reference/services/plan-time/) | Collection |  | No |
| `ref.person` | [Person](/reference/services/person/) | Collection |  | No |
| `ref.plan` | [Plan](/reference/services/plan/) | Collection |  | No |
| `ref.plan_person_times` | [PlanPersonTime](/reference/services/plan-person-time/) | Collection |  | No |
| `ref.plan_times` | [PlanTime](/reference/services/plan-time/) | Collection |  | No |
| `ref.team` | [Team](/reference/services/team/) | Collection |  | No |

## Writing

| Property | Value |
| --- | --- |
| Create | Yes, `create()` on `team_members` on [Plan](/reference/services/plan/), `team_members` on [PlanTemplate](/reference/services/plan-template/) |
| Update | Yes, `update()` on a reference |
| Delete | Yes, `delete()` on a reference |

### Create attributes

Typed as `Services.PlanPersonSchema['create']`.

| Attribute | Type |
| --- | --- |
| `decline_reason` | `string \| null` |
| `declined_plan_times_ids` | `string[]` |
| `notes` | `string \| null` |
| `notification_prepared_at` | `string \| null` |
| `person_id` | `string` |
| `prepare_notification` | `boolean \| null` |
| `responds_to_id` | `string` |
| `service_times_ids` | `string[]` |
| `status` | `string \| null` |
| `team_id` | `string` |
| `team_position_name` | `string \| null` |
| `time_preference_options_ids` | `string[]` |
| `times_ids` | `string[]` |

### Update attributes

Typed as `Services.PlanPersonSchema['update']`.

| Attribute | Type |
| --- | --- |
| `decline_reason` | `string \| null` |
| `declined_plan_times_ids` | `string[]` |
| `notes` | `string \| null` |
| `notification_prepared_at` | `string \| null` |
| `person_id` | `string` |
| `prepare_notification` | `boolean \| null` |
| `responds_to_id` | `string` |
| `service_times_ids` | `string[]` |
| `status` | `string \| null` |
| `team_id` | `string` |
| `team_position_name` | `string \| null` |
| `time_preference_options_ids` | `string[]` |
| `times_ids` | `string[]` |

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

## Example

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

const personId = '1'; // Person id

const page = await pco.services.people.id(personId).plan_people.perPage(25).list();
const items: Services.PlanPerson[] = page.data;
```

Source: https://planningcenterkit.mackenly.com/reference/services/plan-person/index.mdx
