An event.
May contain information such as who owns the event, visibility on Church Center and a public-facing summary.
| Property | Value |
|---|---|
| Product | Calendar (pco.calendar, API version 2026-06-22) |
| Resource type | Event |
| TypeScript | Calendar.Event, attributes Calendar.EventAttributes, schema Calendar.EventSchema |
| Planning Center path | /calendar/v2/events |
| Planning Center docs | Event |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.calendar.events |
Collection | future |
No |
pco.calendar.attachments.id(attachmentId).event |
Collection | No | |
pco.calendar.calendars.id(calendarId).events |
Collection | No | |
pco.calendar.conflicts.id(conflictId).winner |
Collection | No | |
pco.calendar.event_instances.id(eventInstanceId).event |
Collection | No | |
pco.calendar.event_resource_requests.id(eventResourceRequestId).event |
Collection | No | |
pco.calendar.event_instances.id(eventInstanceId).event_times.id(eventTimeId).event |
Collection | No | |
pco.calendar.tags.id(tagId).events |
Collection | No | |
pco.calendar.tag_groups.id(tagGroupId).events |
Collection | No |
From a collection, .id(eventId) addresses one Event: pco.calendar.events.id(eventId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Calendar.EventAttributes. Every resource also has id and type ('Event') next to its attributes.
| Name | Type | Description |
|---|---|---|
approval_status |
string | null |
See details. |
created_at |
string | null |
UTC time at which the event was created |
description |
string | null |
A rich text public-facing summary of the event |
featured |
boolean | null |
See details. |
image_url |
string | null |
Path to where the event image is stored |
link_only |
boolean | null |
See details. |
name |
string | null |
The name of the event |
percent_approved |
number | null |
See details. |
percent_rejected |
number | null |
See details. |
registration_url |
string | null |
The registration URL for the event |
summary |
string | null |
A plain text public-facing summary of the event |
updated_at |
string | null |
UTC time at which the event was updated |
visible_in_church_center |
boolean | null |
See details. |
Attribute details
approval_status
Possible values:
A: approved.P: pending.R: rejected.
featured
trueindicates the event is featured on Church Centerfalseindicates the event is not featured on Church Center
link_only
trueindicates the event is published to Church Center through the link onlyfalseindicates the event is published to Church Center normally
percent_approved
Calculated by taking the sum of the percent_approved for all
future ReservationBlocks and dividing that by the count of all future
ReservationBlocks.
If there are no future ReservationBlocks, returns 100
percent_rejected
Calculated by taking the sum of the percent_rejected for all
future ReservationBlocks and dividing that by the count of all future
ReservationBlocks.
If there are no future ReservationBlocks, returns 0
visible_in_church_center
trueindicates the event Church Center visibility is set to ‘Published’falseindicates the event Church Center visibility is set to ‘Hidden’
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): attachments, calendar, feed, owner, tags.
Querying
Where
where(field, value) for equality; where(field, op, value) with the operators listed.
| Field | Value type | Operators |
|---|---|---|
approval_status |
string |
Equality only |
created_at |
string | Date |
gt, gte, lt, lte |
featured |
boolean |
Equality only |
link_only |
boolean |
Equality only |
name |
string |
Equality only |
percent_approved |
number |
Equality only |
percent_rejected |
number |
Equality only |
updated_at |
string | Date |
gt, gte, lt, lte |
visible_in_church_center |
boolean |
Equality only |
No documented order fields.
Filters
filter(...) names depend on the edge you query through:
| Edge | Filters |
|---|---|
pco.calendar.events |
future |
Edges
Follow these from one Event, ref = pco.calendar.events.id(eventId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.attachments |
Attachment | Collection | No | |
ref.calendar |
Calendar | Collection | No | |
ref.conflicts |
Conflict | Collection | No | |
ref.event_connections |
EventConnection | Collection | Yes | |
ref.event_instances |
EventInstance | Collection | canceled, future, not_canceled |
No |
ref.event_resource_requests |
EventResourceRequest | Collection | No | |
ref.feed |
Feed | Collection | No | |
ref.owner |
Person | Collection | No | |
ref.resource_bookings |
ResourceBooking | Collection | future |
No |
ref.tags |
Tag | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Calendar } from '@mackenly/planningcenterkit';
const page = await pco.calendar.events.perPage(25).list();
const items: Calendar.Event[] = page.data;