A recurring event which people may attend.
Each recurrence is an event period (which often corresponds to a week).
Event periods have event times where people may actually check in.
| Property | Value |
|---|---|
| Product | Check-Ins (pco.checkIns, API version 2025-05-28) |
| Resource type | Event |
| TypeScript | CheckIns.Event, attributes CheckIns.EventAttributes, schema CheckIns.EventSchema |
| Planning Center path | /check-ins/v2/events |
| Planning Center docs | Event |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.checkIns.events |
Collection | archived, for_campus, for_headcounts, for_registrations, not_archived |
No |
pco.checkIns.events.id(eventId).attendance_types.id(attendanceTypeId).event |
Collection | No | |
pco.checkIns.check_ins.id(checkInId).event |
Collection | No | |
pco.checkIns.events.id(eventId).event_labels.id(eventLabelId).event |
Collection | No | |
pco.checkIns.check_ins.id(checkInId).event_period.id(eventPeriodId).event |
Collection | No | |
pco.checkIns.event_times.id(eventTimeId).event |
Collection | No | |
pco.checkIns.check_ins.id(checkInId).locations.id(locationId).event |
Collection | No | |
pco.checkIns.events.id(eventId).person_events.id(personEventId).event |
Collection | No | |
pco.checkIns.stations.id(stationId).event |
Collection | No |
From a collection, .id(eventId) addresses one Event: pco.checkIns.events.id(eventId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On CheckIns.EventAttributes. Every resource also has id and type ('Event') next to its attributes.
| Name | Type | Description |
|---|---|---|
app_source |
string | null |
Only available when requested with the ?fields param |
archived_at |
string | null |
|
created_at |
string | null |
|
enable_services_integration |
boolean | null |
|
frequency |
string | null |
|
integration_key |
string | null |
|
location_times_enabled |
boolean | null |
|
name |
string | null |
|
pre_select_enabled |
boolean | null |
|
updated_at |
string | null |
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): attendance_types.
| Relationship | Type | To | Includable |
|---|---|---|---|
campuses |
To many | Campus |
No |
Querying
Where
where(field, value) for equality; where(field, op, value) with the operators listed.
| Field | Value type | Operators |
|---|---|---|
id |
string |
Equality only |
name |
string |
Equality only |
Order
order(...) accepts these fields, ascending, or descending with a - prefix: created_at, name.
Filters
filter(...) names depend on the edge you query through:
| Edge | Filters |
|---|---|
pco.checkIns.events |
archived, for_campus, for_headcounts, for_registrations, not_archived |
Edges
Follow these from one Event, ref = pco.checkIns.events.id(eventId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.attendance_types |
AttendanceType | Collection | No | |
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.current_event_times |
EventTime | Collection | No | |
ref.event_labels |
EventLabel | Collection | No | |
ref.event_periods |
EventPeriod | Collection | No | |
ref.integration_links |
IntegrationLink | Collection | No | |
ref.locations |
Location | Collection | locations, root |
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.events.order('created_at').perPage(25).list();
const items: CheckIns.Event[] = page.data;