Skip to content

EventTime (Check-Ins)

A time that someone may check in.

A time that someone may check in. Times are copied from session to session.

Property Value
Product Check-Ins (pco.checkIns, API version 2025-05-28)
Resource type EventTime
TypeScript CheckIns.EventTime, attributes CheckIns.EventTimeAttributes, schema CheckIns.EventTimeSchema
Planning Center path /check-ins/v2/event_times
Planning Center docs EventTime

How to reach it

Client path Returns Filters Create
pco.checkIns.event_times Collection No
pco.checkIns.check_ins.id(checkInId).event_times Collection No
pco.checkIns.events.id(eventId).current_event_times Collection No
pco.checkIns.check_ins.id(checkInId).event_period.id(eventPeriodId).event_times Collection available No
pco.checkIns.headcounts.id(headcountId).event_time Collection No
pco.checkIns.event_times.id(eventTimeId).location_event_times.id(locationEventTimeId).event_time Collection No

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

Attributes

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

Name Type Description
created_at string | null
day_of_week number | null
guest_count number | null
hides_at string | null
hour number | null
minute number | null
name string | null
regular_count number | null
shows_at string | null
starts_at string | null
total_count number | null
updated_at string | null
volunteer_count number | null

Relationships and includes

Side-load with include() (or get({ include })) and read with related(resource, name): event, event_period, headcounts.

Relationship Type To Includable
event To one Event Yes
event_period To one EventPeriod Yes

Querying

Where

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

Field Value type Operators
created_at string | Date gt, gte, lt, lte
updated_at string | Date gt, gte, lt, lte

Order

order(...) accepts these fields, ascending, or descending with a - prefix: shows_at, starts_at.

Filters

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

Edge Filters
event_times on EventPeriod available

Edges

Follow these from one EventTime, ref = pco.checkIns.event_times.id(eventTimeId):

Edge Leads to Returns Filters Create
ref.available_locations Location Collection No
ref.check_ins CheckIn Collection attendee, checked_out, first_time, guest, not_checked_out, not_one_time_guest, one_time_guest, regular, volunteer No
ref.event Event Collection No
ref.event_period EventPeriod Collection No
ref.headcounts Headcount Collection No
ref.location_event_times LocationEventTime Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

import type { CheckIns } from '@mackenly/planningcenterkit';

const page = await pco.checkIns.event_times.order('shows_at').perPage(25).list();
const items: CheckIns.EventTime[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close