An attendee, volunteer or administrator.
Usually, a person who checked in will be present as a Person. In some cases, they may not be present:
- The person was manually deleted from the admin interface
- The check-in was created as a “Visitor - Label Only” (which doesn’t create a corresponding person record)
| Property | Value |
|---|---|
| Product | Check-Ins (pco.checkIns, API version 2025-05-28) |
| Resource type | Person |
| TypeScript | CheckIns.Person, attributes CheckIns.PersonAttributes, schema CheckIns.PersonSchema |
| Planning Center path | /check-ins/v2/people |
| Planning Center docs | Person |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.checkIns.people |
Collection | No | |
pco.checkIns.check_ins.id(checkInId).checked_in_by |
Collection | No | |
pco.checkIns.check_ins.id(checkInId).checked_out_by |
Collection | No | |
pco.checkIns.check_ins.id(checkInId).person |
Collection | No | |
pco.checkIns.passes.id(passId).person |
Collection | No | |
pco.checkIns.events.id(eventId).person_events.id(personEventId).person |
Collection | No |
From a collection, .id(personId) addresses one Person: pco.checkIns.people.id(personId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On CheckIns.PersonAttributes. Every resource also has id and type ('Person') next to its attributes.
| Name | Type | Description |
|---|---|---|
addresses |
unknown[] | null |
|
avatar_url |
string | null |
|
birthdate |
string | null |
|
check_in_count |
number | null |
|
child |
boolean | null |
|
created_at |
string | null |
|
demographic_avatar_url |
string | null |
|
email_addresses |
unknown[] | null |
|
first_name |
string | null |
|
gender |
string | null |
|
grade |
number | null |
|
headcounter |
boolean | null |
|
ignore_filters |
boolean | null |
|
last_checked_in_at |
string | null |
|
last_name |
string | null |
|
medical_notes |
string | null |
|
middle_name |
string | null |
|
name |
string | null |
|
name_prefix |
string | null |
|
name_suffix |
string | null |
|
passed_background_check |
boolean | null |
|
permission |
string | null |
|
phone_numbers |
unknown[] | null |
|
top_permission |
string | null |
|
updated_at |
string | null |
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): organization.
Querying
Where
where(field, value) for equality; where(field, op, value) with the operators listed.
| Field | Value type | Operators |
|---|---|---|
headcounter |
boolean |
Equality only |
ignore_filters |
boolean |
Equality only |
permission |
string |
Equality only |
search_name |
string |
Equality only |
Order
order(...) accepts these fields, ascending, or descending with a - prefix: check_in_count, first_name, last_checked_in_at, last_name.
Edges
Follow these from one Person, ref = pco.checkIns.people.id(personId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.check_ins |
CheckIn | Collection | attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer |
No |
ref.organization |
Organization | Collection | No | |
ref.passes |
Pass | Collection | No | |
ref.person_events |
PersonEvent | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { CheckIns } from '@mackenly/planningcenterkit';
const page = await pco.checkIns.people.order('check_in_count').perPage(25).list();
const items: CheckIns.Person[] = page.data;