A person scheduled within a specific plan.
| Property | Value |
|---|---|
| Product | 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 |
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; 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 | Yes |
plan |
To one | Plan | Yes |
responds_to |
To one | Person | No |
scheduled_by |
To one | Person | No |
service_times |
To many | PlanTime | No |
service_type |
To one | ServiceType | No |
team |
To one | Team | Yes |
time_preference_options |
To many | TimePreferenceOption | No |
times |
To many | PlanTime | 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 |
confirmed, not_archived, not_declined, not_deleted |
team_members on PlanTemplate |
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 | Collection | No | |
ref.person |
Person | Collection | No | |
ref.plan |
Plan | Collection | No | |
ref.plan_person_times |
PlanPersonTime | Collection | No | |
ref.plan_times |
PlanTime | Collection | No | |
ref.team |
Team | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | Yes, create() on team_members on Plan, team_members on PlanTemplate |
| 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.
Example
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;