Enables quick lookup of a person via barcode reader.
| Property | Value |
|---|---|
| Product | Check-Ins (pco.checkIns, API version 2025-05-28) |
| Resource type | Pass |
| TypeScript | CheckIns.Pass, attributes CheckIns.PassAttributes, schema CheckIns.PassSchema |
| Planning Center path | /check-ins/v2/passes |
| Planning Center docs | Pass |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.checkIns.passes |
Collection | No | |
pco.checkIns.people.id(personId).passes |
Collection | No |
From a collection, .id(passId) addresses one Pass: pco.checkIns.passes.id(passId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On CheckIns.PassAttributes. Every resource also has id and type ('Pass') next to its attributes.
| Name | Type | Description |
|---|---|---|
code |
string | null |
|
created_at |
string | null |
|
kind |
string | null |
See details. |
updated_at |
string | null |
Attribute details
kind
Possible values: barcode or pkpass.
Using the pkpass value creates a mobile pass and sends an email to the associated person.
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): person.
Querying
Where
where(field, value) for equality; where(field, op, value) with the operators listed.
| Field | Value type | Operators |
|---|---|---|
code |
string |
Equality only |
No documented order fields.
Edges
Follow these from one Pass, ref = pco.checkIns.passes.id(passId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.person |
Person | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { CheckIns } from '@mackenly/planningcenterkit';
const page = await pco.checkIns.passes.perPage(25).list();
const items: CheckIns.Pass[] = page.data;