A kind of attendee which is tracked by headcount, not by check-in.
| Property | Value |
|---|---|
| Product | Check-Ins (pco.checkIns, API version 2025-05-28) |
| Resource type | AttendanceType |
| TypeScript | CheckIns.AttendanceType, attributes CheckIns.AttendanceTypeAttributes, schema CheckIns.AttendanceTypeSchema |
| Planning Center path | /check-ins/v2/events/{event_id}/attendance_types |
| Planning Center docs | AttendanceType |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.checkIns.events.id(eventId).attendance_types |
Collection | No | |
pco.checkIns.headcounts.id(headcountId).attendance_type |
Collection | No |
From a collection, .id(attendanceTypeId) addresses one AttendanceType: pco.checkIns.events.id(eventId).attendance_types.id(attendanceTypeId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On CheckIns.AttendanceTypeAttributes. Every resource also has id and type ('AttendanceType') next to its attributes.
| Name | Type | Description |
|---|---|---|
color |
string | null |
|
created_at |
string | null |
|
limit |
number | null |
|
name |
string | null |
|
updated_at |
string | null |
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): event.
| Relationship | Type | To | Includable |
|---|---|---|---|
event |
To one | Event | Yes |
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 |
No documented order fields.
Edges
Follow these from one AttendanceType, ref = pco.checkIns.events.id(eventId).attendance_types.id(attendanceTypeId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.event |
Event | Collection | No | |
ref.headcounts |
Headcount | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { CheckIns } from '@mackenly/planningcenterkit';
const eventId = '1'; // Event id
const page = await pco.checkIns.events.id(eventId).attendance_types.perPage(25).list();
const items: CheckIns.AttendanceType[] = page.data;