Skip to content

LocationEventTime (Check-Ins)

Counts check-ins for a location for a given event time.

Counts check-ins for a location for a given event time. This is useful for checking occupancy.

Property Value
Product Check-Ins (pco.checkIns, API version 2025-05-28)
Resource type LocationEventTime
TypeScript CheckIns.LocationEventTime, attributes CheckIns.LocationEventTimeAttributes, schema CheckIns.LocationEventTimeSchema
Planning Center path /check-ins/v2/event_times/{event_time_id}/location_event_times
Planning Center docs LocationEventTime

How to reach it

Client path Returns Filters Create
pco.checkIns.event_times.id(eventTimeId).location_event_times Collection No
pco.checkIns.check_ins.id(checkInId).locations.id(locationId).location_event_times Collection No

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

Attributes

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

Name Type Description
created_at string | null
guest_count number | null
regular_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_time, location.

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

No documented order fields.

Edges

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

Edge Leads to Returns Filters Create
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_time EventTime Collection No
ref.location Location Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

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

const eventTimeId = '1'; // EventTime id

const page = await pco.checkIns.event_times.id(eventTimeId).location_event_times.perPage(25).list();
const items: CheckIns.LocationEventTime[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close