Events, check-ins, locations, stations, labels, passes, and headcounts.
| Property | Value |
|---|---|
| Client property | pco.checkIns |
| Subpath import | import { createCheckInsClient } from '@mackenly/planningcenterkit/check-ins' |
| Types namespace | CheckIns |
| Base path | /check-ins/v2 |
| Pinned API version | 2025-05-28 |
| Resource types | 24 |
| Planning Center docs | Planning Center Check-Ins API |
Each product client sends X-PCO-API-Version: 2025-05-28, the version these types were generated from. Override it with new PlanningCenter({ auth, versions: { checkIns: '...' } }); the types won’t follow. See Products.
import { createCheckInsClient } from '@mackenly/planningcenterkit/check-ins';
const checkIns = createCheckInsClient({ auth: { applicationId: process.env.PCO_APP_ID!, secret: process.env.PCO_SECRET! } });
const { data: root } = await checkIns.get(); // /check-ins/v2Root collections
Properties on pco.checkIns, named after their URL. pco.checkIns.get() fetches the product root (/check-ins/v2), and pco.checkIns.edge(name) follows any root edge by name.
| Client path | Resource | Returns | Filters | Create |
|---|---|---|---|---|
pco.checkIns.check_ins |
CheckIn | Collection | attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer |
No |
pco.checkIns.event_times |
EventTime | Collection | No | |
pco.checkIns.events |
Event | Collection | archived, for_campus, for_headcounts, for_registrations, not_archived |
No |
pco.checkIns.headcounts |
Headcount | Collection | No | |
pco.checkIns.integration_links |
IntegrationLink | Collection | No | |
pco.checkIns.labels |
Label | Collection | No | |
pco.checkIns.options |
Option | Collection | No | |
pco.checkIns.passes |
Pass | Collection | No | |
pco.checkIns.people |
Person | Collection | No | |
pco.checkIns.stations |
Station | Collection | No | |
pco.checkIns.themes |
Theme | Collection | No |
Resources
| Resource | TypeScript | Description |
|---|---|---|
| AttendanceType | CheckIns.AttendanceType |
A kind of attendee which is tracked by headcount, not by check-in. |
| CheckIn | CheckIns.CheckIn |
An attendance record for an event. |
| CheckInGroup | CheckIns.CheckInGroup |
When one or more people check in, they’re grouped in a CheckInGroup. |
| CheckInTime | CheckIns.CheckInTime |
A CheckInTime combines an EventTime and a Location, and associates it with the parent CheckIn. |
| Event | CheckIns.Event |
A recurring event which people may attend. |
| EventLabel | CheckIns.EventLabel |
Says how many of a given label to print for this event and whether to print it for regulars, guests, and/or volunteers. |
| EventPeriod | CheckIns.EventPeriod |
A recurrence of an event, sometimes called a “session”. |
| EventTime | CheckIns.EventTime |
A time that someone may check in. |
| Headcount | CheckIns.Headcount |
A tally of attendees for a given event time and attendance type. |
| IntegrationLink | CheckIns.IntegrationLink |
A record linking another product’s resource to a Check-Ins resource. |
| Label | CheckIns.Label |
Labels can be set to print for events (through EventLabels), locations (through LocationLabels) or options. |
| Location | CheckIns.Location |
A place where people may check in to for a given event. |
| LocationEventPeriod | CheckIns.LocationEventPeriod |
Counts check-ins for a location during a certain event period. |
| LocationEventTime | CheckIns.LocationEventTime |
Counts check-ins for a location for a given event time. |
| LocationLabel | CheckIns.LocationLabel |
Says how many of a given label to print for this location and whether to print it for regulars, guests, and/or volunteers. |
| Option | CheckIns.Option |
An option which an attendee may select when checking in. |
| Organization | CheckIns.Organization |
An organization which has people and events. |
| Pass | CheckIns.Pass |
Enables quick lookup of a person via barcode reader. |
| Person | CheckIns.Person |
An attendee, volunteer or administrator. |
| PersonEvent | CheckIns.PersonEvent |
Counts a person’s attendence for a given event. |
| PreCheck | CheckIns.PreCheck |
|
| RosterListPerson | CheckIns.RosterListPerson |
|
| Station | CheckIns.Station |
A device where people can be checked in. |
| Theme | CheckIns.Theme |
A custom style which may be applied to stations. |