Counts a person’s attendence for a given event.
| Property | Value |
|---|---|
| Product | Check-Ins (pco.checkIns, API version 2025-05-28) |
| Resource type | PersonEvent |
| TypeScript | CheckIns.PersonEvent, attributes CheckIns.PersonEventAttributes, schema CheckIns.PersonEventSchema |
| Planning Center path | /check-ins/v2/events/{event_id}/person_events |
| Planning Center docs | PersonEvent |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.checkIns.events.id(eventId).person_events |
Collection | No | |
pco.checkIns.people.id(personId).person_events |
Collection | No |
From a collection, .id(personEventId) addresses one PersonEvent: pco.checkIns.events.id(eventId).person_events.id(personEventId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On CheckIns.PersonEventAttributes. Every resource also has id and type ('PersonEvent') next to its attributes.
| Name | Type | Description |
|---|---|---|
check_in_count |
number | null |
|
created_at |
string | null |
|
updated_at |
string | null |
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): event, first_check_in, last_check_in, person.
Querying
No documented where fields.
No documented order fields.
Edges
Follow these from one PersonEvent, ref = pco.checkIns.events.id(eventId).person_events.id(personEventId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.event |
Event | Collection | No | |
ref.first_check_in |
CheckIn | Collection | No | |
ref.last_check_in |
CheckIn | Collection | No | |
ref.person |
Person | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { CheckIns } from '@mackenly/planningcenterkit';
const eventId = '1'; // Event id
const page = await pco.checkIns.events.id(eventId).person_events.perPage(25).list();
const items: CheckIns.PersonEvent[] = page.data;