Counts check-ins for a location during a certain event period.
| Property | Value |
|---|---|
| Product | Check-Ins (pco.checkIns, API version 2025-05-28) |
| Resource type | LocationEventPeriod |
| TypeScript | CheckIns.LocationEventPeriod, attributes CheckIns.LocationEventPeriodAttributes, schema CheckIns.LocationEventPeriodSchema |
| Planning Center path | /check-ins/v2/check_ins/{check_in_id}/event_period/{event_period_id}/location_event_periods |
| Planning Center docs | LocationEventPeriod |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.checkIns.check_ins.id(checkInId).event_period.id(eventPeriodId).location_event_periods |
Collection | No | |
pco.checkIns.check_ins.id(checkInId).locations.id(locationId).location_event_periods |
Collection | No |
From a collection, .id(locationEventPeriodId) addresses one LocationEventPeriod: pco.checkIns.check_ins.id(checkInId).event_period.id(eventPeriodId).location_event_periods.id(locationEventPeriodId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On CheckIns.LocationEventPeriodAttributes. Every resource also has id and type ('LocationEventPeriod') next to its attributes.
| Name | Type | Description |
|---|---|---|
created_at |
string | null |
|
guest_count |
number | null |
|
regular_count |
number | null |
|
updated_at |
string | null |
|
volunteer_count |
number | null |
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): event_period, location.
Querying
No documented where fields.
No documented order fields.
Edges
Follow these from one LocationEventPeriod, ref = pco.checkIns.check_ins.id(checkInId).event_period.id(eventPeriodId).location_event_periods.id(locationEventPeriodId):
| 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.event_period |
EventPeriod | Collection | No | |
ref.location |
Location | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { CheckIns } from '@mackenly/planningcenterkit';
const checkInId = '1'; // CheckIn id
const eventPeriodId = '1'; // EventPeriod id
const page = await pco.checkIns.check_ins.id(checkInId).event_period.id(eventPeriodId).location_event_periods.perPage(25).list();
const items: CheckIns.LocationEventPeriod[] = page.data;