Skip to content

CheckIn (Check-Ins)

An attendance record for an event.

An attendance record for an event.

If someone was checked out, checked_out_at will be present.

You can scope check-ins in a few ways:

  • regulars, guests, and volunteers correspond to the option selected when checking in.
  • attendees are regulars and guests together.
  • one_time_guests are check-ins which were created without a corresponding person record.
  • not_one_time_guests are check-ins which had a corresponding person record when they were created.
  • checked_out are check-ins where checked_out_at is present (meaning they were checked out from a station).
  • first_times are check-ins which are the person’s first for a given event. (Label-only visitors are not included here.)
Property Value
Product Check-Ins (pco.checkIns, API version 2025-05-28)
Resource type CheckIn
TypeScript CheckIns.CheckIn, attributes CheckIns.CheckInAttributes, schema CheckIns.CheckInSchema
Planning Center path /check-ins/v2/check_ins
Planning Center docs CheckIn

How to reach it

Client path Returns Filters Create
pco.checkIns.check_ins Collection attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer No
pco.checkIns.check_ins.id(checkInId).check_in_group.id(checkInGroupId).check_ins Collection No
pco.checkIns.events.id(eventId).check_ins Collection attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer No
pco.checkIns.check_ins.id(checkInId).event_period.id(eventPeriodId).check_ins Collection attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer No
pco.checkIns.event_times.id(eventTimeId).check_ins Collection attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer No
pco.checkIns.check_ins.id(checkInId).locations.id(locationId).check_ins Collection attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer No
pco.checkIns.check_ins.id(checkInId).event_period.id(eventPeriodId).location_event_periods.id(locationEventPeriodId).check_ins Collection attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer No
pco.checkIns.event_times.id(eventTimeId).location_event_times.id(locationEventTimeId).check_ins Collection attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer No
pco.checkIns.options.id(optionId).check_ins Collection No
pco.checkIns.people.id(personId).check_ins Collection attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer No
pco.checkIns.events.id(eventId).person_events.id(personEventId).first_check_in Collection No
pco.checkIns.events.id(eventId).person_events.id(personEventId).last_check_in Collection No
pco.checkIns.stations.id(stationId).checked_in_at_check_ins Collection attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer No

From a collection, .id(checkInId) addresses one CheckIn: pco.checkIns.check_ins.id(checkInId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On CheckIns.CheckInAttributes. Every resource also has id and type ('CheckIn') next to its attributes.

Name Type Description
checked_out_at string | null
confirmed_at string | null
created_at string | null
emergency_contact_name string | null
emergency_contact_phone_number string | null
first_name string | null
kind string | null
last_name string | null
medical_notes string | null
number number | null
one_time_guest boolean | null
security_code string | null
updated_at string | null

Relationships and includes

Side-load with include() (or get({ include })) and read with related(resource, name): check_in_times, checked_in_at, checked_in_by, checked_out_by, event, event_period, event_times, locations, options, person.

Relationship Type To Includable
event_period To one EventPeriod Yes
person To one Person Yes

Querying

Where

where(field, value) for equality; where(field, op, value) with the operators listed.

Field Value type Operators
account_center_person_id string | number Equality only
created_at string | Date gt, gte, lt, lte
security_code string Equality only
updated_at string | Date gt, gte, lt, lte

Order

order(...) accepts these fields, ascending, or descending with a - prefix: checked_out_at, created_at, first_name, last_name, number, updated_at.

Filters

filter(...) names depend on the edge you query through:

Edge Filters
pco.checkIns.check_ins attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer
check_ins on Event attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer
check_ins on EventPeriod attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer
check_ins on EventTime attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer
check_ins on Location attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer
check_ins on LocationEventPeriod attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer
check_ins on LocationEventTime attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer
check_ins on Person attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer
checked_in_at_check_ins on Station attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer

Edges

Follow these from one CheckIn, ref = pco.checkIns.check_ins.id(checkInId):

Edge Leads to Returns Filters Create
ref.check_in_group CheckInGroup Collection No
ref.check_in_times CheckInTime Collection No
ref.checked_in_at Station Collection No
ref.checked_in_by Person Collection No
ref.checked_out_by Person Collection No
ref.event Event Collection No
ref.event_period EventPeriod Collection No
ref.event_times EventTime Collection No
ref.locations Location Collection No
ref.options Option Collection No
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.check_ins.order('checked_out_at').perPage(25).list();
const items: CheckIns.CheckIn[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close