A person is a user of Planning Center. They can be a member of a group, a leader of a group, or an administrator.
| Property | Value |
|---|---|
| Product | Groups (pco.groups, API version 2026-11-10) |
| Resource type | Person |
| TypeScript | Groups.Person, attributes Groups.PersonAttributes, schema Groups.PersonSchema |
| Planning Center path | /groups/v2/people |
| Planning Center docs | Person |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.groups.people |
Collection | No | |
pco.groups.events.id(eventId).attendances.id(attendanceId).person |
Collection | No | |
pco.groups.groups.id(groupId).people |
Collection | No | |
pco.groups.group_applications.id(groupApplicationId).person |
Collection | No | |
pco.groups.memberships.id(membershipId).person |
Collection | No |
From a collection, .id(personId) addresses one Person: pco.groups.people.id(personId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Groups.PersonAttributes. Every resource also has id and type ('Person') next to its attributes.
| Name | Type | Description |
|---|---|---|
addresses |
unknown[] | null |
Returns all the addresses associated with this person. |
avatar_url |
string | null |
The URL of the person’s avatar. |
child |
boolean | null |
See details. |
created_at |
string | null |
Date and time this person was first created in Planning Center |
email_addresses |
unknown[] | null |
See details. |
first_name |
string | null |
The person’s first name. |
gender |
string | null |
The person’s gender (e.g. Male, Female). |
last_name |
string | null |
The person’s last name. |
permissions |
string | null |
Can be administrator, group_type_manager, leader, member, or no access. |
phone_numbers |
unknown[] | null |
See details. |
Attribute details
child
Whether or not the person is under 13 years old. This is false if a birthdate is not set.
Only available when requested with the ?fields param
email_addresses
Returns all the email addresses associated with this person.
[{
"address": "sam@example.com",
"location": "Home",
"primary": true
}]phone_numbers
Returns all the phone numbers associated with this person.
[{
"number": "(800) 123-4567",
"carrier": null,
"location": "Mobile",
"primary": true
}]Querying
Where
where(field, value) for equality; where(field, op, value) with the operators listed.
| Field | Value type | Operators |
|---|---|---|
first_name |
string |
Equality only |
last_name |
string |
Equality only |
Order
order(...) accepts these fields, ascending, or descending with a - prefix: first_name, last_name.
Edges
Follow these from one Person, ref = pco.groups.people.id(personId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.events |
Event | Collection | canceled, not_canceled |
No |
ref.groups |
Group | Collection | No | |
ref.memberships |
Membership | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Groups } from '@mackenly/planningcenterkit';
const page = await pco.groups.people.order('first_name').perPage(25).list();
const items: Groups.Person[] = page.data;