Skip to content

EventTime (Calendar)

Start and end times for each event instance.

Start and end times for each event instance.

In the Calendar UI, these are represented under the “Schedule” section and may include “Setup” and “Teardown” times for the instance.

Property Value
Product Calendar (pco.calendar, API version 2026-06-22)
Resource type EventTime
TypeScript Calendar.EventTime, attributes Calendar.EventTimeAttributes, schema Calendar.EventTimeSchema
Planning Center path /calendar/v2/event_instances/{event_instance_id}/event_times
Planning Center docs EventTime

How to reach it

Client path Returns Filters Create
pco.calendar.event_instances.id(eventInstanceId).event_times Collection No

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

Attributes

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

Name Type Description
ends_at string | null UTC time at which the event time ends
name string | null Name of the event time
starts_at string | null UTC time at which the event time starts
visible_on_kiosks boolean | null Set to true if the time is visible on kiosk
visible_on_widget_and_ical boolean | null Set to true if the time is visible on widget or iCal

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
ends_at string | Date gt, gte, lt, lte
name string Equality only
starts_at string | Date gt, gte, lt, lte
visible_on_kiosks boolean Equality only
visible_on_widget_and_ical boolean Equality only

Order

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

Edges

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

Edge Leads to Returns Filters Create
ref.event Event Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

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

const eventInstanceId = '1'; // EventInstance id

const page = await pco.calendar.event_instances.id(eventInstanceId).event_times.order('ends_at').perPage(25).list();
const items: Calendar.EventTime[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close