An event is a meeting of a group. It has a start and end time, and can be either physical or virtual.
| Property | Value |
|---|---|
| Product | Groups (pco.groups, API version 2026-11-10) |
| Resource type | Event |
| TypeScript | Groups.Event, attributes Groups.EventAttributes, schema Groups.EventSchema |
| Planning Center path | /groups/v2/events |
| Planning Center docs | Event |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.groups.events |
Collection | campus, canceled, group, group_type, my_groups, not_canceled, upcoming |
No |
pco.groups.groups.id(groupId).events |
Collection | canceled, not_canceled |
No |
pco.groups.group_types.id(groupTypeId).events |
Collection | canceled, not_canceled, upcoming |
No |
pco.groups.people.id(personId).events |
Collection | canceled, not_canceled |
No |
From a collection, .id(eventId) addresses one Event: pco.groups.events.id(eventId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Groups.EventAttributes. Every resource also has id and type ('Event') next to its attributes.
| Name | Type | Description |
|---|---|---|
attendance_last_requested_at |
string | null |
The date and time leaders were last asked to take attendance for this event. |
attendance_requests_enabled |
boolean | null |
This is a group setting that applies to all the events in the group. If selected, an email will be sent to the primary email address of the group leader 60 minutes before the event start time, asking them to report attendance. |
automated_reminder_enabled |
boolean | null |
If true, we send an event remind some specified time before the event starts to all members in the group. |
canceled |
boolean | null |
Whether or not the event has been canceled. |
canceled_at |
string | null |
The date and time the event was canceled. |
description |
string | null |
A longform description of the event. Can contain HTML markup. |
ends_at |
string | null |
The date and time the event ends. |
image |
Record<string, unknown> | null |
The image for the event. |
location_type_preference |
string | null |
Either “physical” or “virtual”. |
multi_day |
boolean | null |
true if the event spans multiple days. Otherwise false. |
name |
string | null |
The name/title of the event. |
reminders_sent |
boolean | null |
true if reminders have been sent for this event. Otherwise false. |
reminders_sent_at |
string | null |
The date and time reminders were sent for this event. |
repeating |
boolean | null |
true if the event is a repeating event. Otherwise false. |
rsvp_guests_enabled |
boolean | null |
true if people who RSVP can bring guests. Always false when RSVPs are disabled. |
rsvps_enabled |
boolean | null |
true if people can RSVP to this event. Always false for canceled events. |
starts_at |
string | null |
The date and time the event starts. |
virtual_location_url |
string | null |
The URL for the virtual location. Typically we don’t show this URL unless unless the location_type_preference is “virtual”. |
visitors_count |
number | null |
The number of visitors who attended the event. These are people who are not members of the group. |
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): group, location.
| Relationship | Type | To | Includable |
|---|---|---|---|
attendance_submitter |
To one | Person | No |
group |
To one | Group | Yes |
location |
To one | Location | Yes |
repeating_event |
To one | RepeatingEvent |
No |
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 |
Order
order(...) accepts these fields, ascending, or descending with a - prefix: ends_at, name, starts_at.
Filters
filter(...) names depend on the edge you query through:
| Edge | Filters |
|---|---|
pco.groups.events |
campus, canceled, group, group_type, my_groups, not_canceled, upcoming |
events on Group |
canceled, not_canceled |
events on GroupType |
canceled, not_canceled, upcoming |
events on Person |
canceled, not_canceled |
Edges
Follow these from one Event, ref = pco.groups.events.id(eventId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.attendances |
Attendance | Collection | attended |
No |
ref.group |
Group | Collection | No | |
ref.location |
Location | Collection | No | |
ref.notes |
EventNote | Collection | No | |
ref.rsvps |
RSVP | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Groups } from '@mackenly/planningcenterkit';
const page = await pco.groups.events.order('ends_at').perPage(25).list();
const items: Groups.Event[] = page.data;