A person added to Planning Center Services.
| Property | Value |
|---|---|
| Product | Services (pco.services, API version 2018-11-01) |
| Resource type | Person |
| TypeScript | Services.Person, attributes Services.PersonAttributes, schema Services.PersonSchema |
| Planning Center path | /services/v2/people |
| Planning Center docs | Person |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.services.people |
Collection | No | |
pco.services.series.id(seriesId).plans.id(planId).live.id(liveId).controller |
Collection | No | |
pco.services.people.id(personId).person_team_position_assignments.id(personTeamPositionAssignmentId).person |
Collection | No | |
pco.services.people.id(personId).plan_people.id(planPersonId).person |
Collection | No | |
pco.services.teams.id(teamId).people |
Collection | No | |
pco.services.people.id(personId).team_leaders.id(teamLeaderId).people |
Collection | No |
From a collection, .id(personId) addresses one Person: pco.services.people.id(personId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Services.PersonAttributes. Every resource also has id and type ('Person') next to its attributes.
| Name | Type | Description |
|---|---|---|
access_media_attachments |
boolean | null |
|
access_plan_attachments |
boolean | null |
|
access_song_attachments |
boolean | null |
|
anniversary |
string | null |
|
archived |
boolean | null |
|
archived_at |
string | null |
|
assigned_to_rehearsal_team |
boolean | null |
|
birthdate |
string | null |
|
can_edit_all_people |
boolean | null |
|
can_search |
boolean | null |
|
can_view_all_people |
boolean | null |
|
created_at |
string | null |
|
facebook_id |
string | null |
DEPRECATED: this attribute will be removed in the next release and will return the string “DEPRECATED” in this version |
first_name |
string | null |
|
full_name |
string | null |
|
given_name |
string | null |
|
ical_code |
string | null |
|
last_name |
string | null |
|
legacy_id |
string | null |
If you’ve used Person.id from API v1 this attribute can be used to map from those old IDs to the new IDs used in API v2 |
logged_in_at |
string | null |
|
max_permissions |
string | null |
|
max_plan_permissions |
string | null |
|
me_tab |
string | null |
|
media_permissions |
string | null |
The person’s access to media, as a label: Scheduled Viewer, Viewer, Editor, or Administrator. |
media_tab |
string | null |
|
middle_name |
string | null |
|
name_prefix |
string | null |
|
name_suffix |
string | null |
|
nickname |
string | null |
|
notes |
string | null |
|
onboardings |
unknown[] | null |
|
passed_background_check |
boolean | null |
|
people_tab |
string | null |
|
permissions |
string | null |
DEPRECATED: use plan_permissions instead. Both name the same value; this one is ambiguous about which permission scale it refers to. |
person_permissions |
string | null |
See details. |
photo_thumbnail_url |
string | null |
|
photo_url |
string | null |
|
plan_permissions |
string | null |
The person’s organization-wide plan permission, as a label: Archived, Scheduled Viewer, Viewer, Scheduler, Editor, or Administrator. |
plans_tab |
string | null |
|
praise_charts_enabled |
boolean | null |
|
preferred_app |
string | null |
|
preferred_max_plans_per_day |
number | null |
|
preferred_max_plans_per_month |
number | null |
|
profile_name |
string | null |
Only available when requested with the ?fields param |
signature |
string | null |
Only available when requested with the ?fields param |
site_administrator |
boolean | null |
|
song_permissions |
string | null |
The person’s access to songs and arrangements, as a label: Scheduled Viewer, Viewer, Editor, or Administrator. |
songs_tab |
string | null |
|
status |
string | null |
|
updated_at |
string | null |
Attribute details
person_permissions
Reserved for future use.
Only available when requested with the ?fields param
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): emails, tags, team_leaders.
| Relationship | Type | To | Includable |
|---|---|---|---|
created_by |
To one | Person | No |
current_folder |
To one | Folder | No |
updated_by |
To one | Person | No |
Querying
Where
where(field, value) for equality; where(field, op, value) with the operators listed.
| Field | Value type | Operators |
|---|---|---|
assigned_to_rehearsal_team |
boolean |
Equality only |
legacy_id |
string |
Equality only |
Order
order(...) accepts these fields, ascending, or descending with a - prefix: created_at, first_name, last_name, updated_at.
Edges
Follow these from one Person, ref = pco.services.people.id(personId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.available_signups |
AvailableSignup | Collection | current_organization |
No |
ref.blockouts |
Blockout | Collection | future, past |
Yes |
ref.emails |
Collection | No | ||
ref.person_team_position_assignments |
PersonTeamPositionAssignment | Collection | not_archived, not_deleted |
No |
ref.plan_people |
PlanPerson | Collection | No | |
ref.schedules |
Schedule | Collection | after, all, before, future, not_across_organizations, past, with_declined |
No |
ref.scheduling_preferences |
SchedulingPreference | Collection | No | |
ref.tags |
Tag | Collection | No | |
ref.team_leaders |
TeamLeader | Collection | not_archived, not_deleted |
No |
ref.text_settings |
TextSetting | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | Yes, update() on a reference |
| Delete | No |
Update attributes
Typed as Services.PersonSchema['update'].
| Attribute | Type |
|---|---|
access_media_attachments |
boolean | null |
access_plan_attachments |
boolean | null |
access_song_attachments |
boolean | null |
current_folder_id |
string |
media_permissions |
string | null |
onboardings |
unknown[] | null |
permissions |
string | null |
person_permissions |
string | null |
plan_permissions |
string | null |
preferred_app |
string | null |
remembered_items |
unknown |
song_permissions |
string | null |
See Writing data.
Actions
Run with ref.action(name, body?). Bodies are untyped: see Planning Center’s docs for each action.
| Action | Path | Description |
|---|---|---|
assign_tags |
POST /services/v2/people/{person_id}/assign_tags |
Used to assign tags to a person. |
collapse_service_types |
POST /services/v2/people/{person_id}/collapse_service_types |
Used to set Service Types as collapsed for the Person |
expand_service_types |
POST /services/v2/people/{person_id}/expand_service_types |
Used to set Service Types as expanded for the Person |
Example
import type { Services } from '@mackenly/planningcenterkit';
const page = await pco.services.people.order('created_at').perPage(25).list();
const items: Services.Person[] = page.data;