When one or more people check in, they’re grouped in a CheckInGroup.
These check-ins all have the same “checked-in by” person.
| Property | Value |
|---|---|
| Product | Check-Ins (pco.checkIns, API version 2025-05-28) |
| Resource type | CheckInGroup |
| TypeScript | CheckIns.CheckInGroup, attributes CheckIns.CheckInGroupAttributes, schema CheckIns.CheckInGroupSchema |
| Planning Center path | /check-ins/v2/stations/{station_id}/check_in_groups |
| Planning Center docs | CheckInGroup |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.checkIns.check_ins.id(checkInId).check_in_group |
Collection | No | |
pco.checkIns.stations.id(stationId).check_in_groups |
Collection | canceled, printed, ready, skipped |
No |
From a collection, .id(checkInGroupId) addresses one CheckInGroup: pco.checkIns.check_ins.id(checkInId).check_in_group.id(checkInGroupId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On CheckIns.CheckInGroupAttributes. Every resource also has id and type ('CheckInGroup') next to its attributes.
| Name | Type | Description |
|---|---|---|
check_ins_count |
number | null |
|
created_at |
string | null |
|
name_labels_count |
number | null |
|
print_status |
string | null |
See details. |
security_labels_count |
number | null |
|
updated_at |
string | null |
Attribute details
print_status
Possible values:
ready: This group isn’t printed or canceled yetprinted: This group was successfully printed at a stationcanceled: This group was canceled at a stationskipped: This group had no labels to print, so it was never printed.
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): check_ins, event_period, print_station.
Querying
No documented where fields.
No documented order fields.
Filters
filter(...) names depend on the edge you query through:
| Edge | Filters |
|---|---|
check_in_groups on Station |
canceled, printed, ready, skipped |
Edges
Follow these from one CheckInGroup, ref = pco.checkIns.check_ins.id(checkInId).check_in_group.id(checkInGroupId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.check_ins |
CheckIn | Collection | No | |
ref.event_period |
EventPeriod | Collection | No | |
ref.print_station |
Station | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { CheckIns } from '@mackenly/planningcenterkit';
const checkInId = '1'; // CheckIn id
const page = await pco.checkIns.check_ins.id(checkInId).check_in_group.perPage(25).list();
const items: CheckIns.CheckInGroup[] = page.data;