Labels can be set to print for events (through EventLabels),
locations (through LocationLabels) or options.
Label type (security label / name label) is expressed with the
prints_for attribute. prints_for="Person" is a name label,
prints_for="Group" is a security label.
| Property | Value |
|---|---|
| Product | Check-Ins (pco.checkIns, API version 2025-05-28) |
| Resource type | Label |
| TypeScript | CheckIns.Label, attributes CheckIns.LabelAttributes, schema CheckIns.LabelSchema |
| Planning Center path | /check-ins/v2/labels |
| Planning Center docs | Label |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.checkIns.labels |
Collection | No | |
pco.checkIns.events.id(eventId).event_labels.id(eventLabelId).label |
Collection | No | |
pco.checkIns.labels.id(labelId).location_labels.id(locationLabelId).label |
Collection | No | |
pco.checkIns.options.id(optionId).label |
Collection | No |
From a collection, .id(labelId) addresses one Label: pco.checkIns.labels.id(labelId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On CheckIns.LabelAttributes. Every resource also has id and type ('Label') next to its attributes.
| Name | Type | Description |
|---|---|---|
created_at |
string | null |
|
name |
string | null |
|
prints_for |
string | null |
|
roll |
string | null |
|
updated_at |
string | null |
|
xml |
string | null |
Querying
No documented where fields.
No documented order fields.
Edges
Follow these from one Label, ref = pco.checkIns.labels.id(labelId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.event_labels |
EventLabel | Collection | No | |
ref.location_labels |
LocationLabel | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { CheckIns } from '@mackenly/planningcenterkit';
const page = await pco.checkIns.labels.perPage(25).list();
const items: CheckIns.Label[] = page.data;