---
title: "EventInstance (Calendar)"
description: "A specific occurrence of an event."
---

> Documentation Index
> Fetch the complete documentation index at: https://planningcenterkit.mackenly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# EventInstance (Calendar)

A specific occurrence of an event.

If the event is recurring, `recurrence` will be set and
`recurrence_description` will provide an overview of the recurrence pattern.

| Property | Value |
| --- | --- |
| Product | [Calendar](/reference/calendar/) (`pco.calendar`, API version `2026-06-22`) |
| Resource type | `EventInstance` |
| TypeScript | `Calendar.EventInstance`, attributes `Calendar.EventInstanceAttributes`, schema `Calendar.EventInstanceSchema` |
| Planning Center path | `/calendar/v2/event_instances` |
| Planning Center docs | [EventInstance](https://api.planningcenteronline.com/docs/apps/calendar/versions/2026-06-22/vertices/event_instance) |

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.calendar.event_instances` | Collection | `all`, `approved`, `approved_conflict`, `approved_pending`, `approved_pending_conflict`, `approved_pending_rejected`, `approved_pending_rejected_conflict`, `approved_rejected`, `approved_rejected_conflict`, `approver`, `approver_subscriber`, `canceled`, `conflict`, `event_request_approved`, `event_request_approved_pending`, `event_request_approved_pending_rejected`, `event_request_approved_rejected`, `event_request_pending`, `event_request_pending_rejected`, `event_request_rejected`, `future`, `lost`, `lost_due_to_blockout`, `manager`, `manager_approver`, `manager_approver_subscriber`, `manager_subscriber`, `not_canceled`, `not_pending_event_requests`, `owner`, `owner_approver`, `owner_approver_subscriber`, `owner_manager`, `owner_manager_approver`, `owner_manager_approver_subscriber`, `owner_manager_subscriber`, `owner_subscriber`, `pending`, `pending_conflict`, `pending_rejected`, `pending_rejected_conflict`, `rejected`, `rejected_conflict`, `shared`, `subscriber`, `unresolved` | No |
| `pco.calendar.events.id(eventId).event_instances` | Collection | `canceled`, `future`, `not_canceled` | No |
| `pco.calendar.tags.id(tagId).event_instances` | Collection | `canceled`, `not_canceled` | No |

From a collection, `.id(eventInstanceId)` addresses one EventInstance: `pco.calendar.event_instances.id(eventInstanceId)`. Collections support [`where`, `include`, `order`, and pagination](/guides/querying/); single resources have `get()`.

## Attributes

On `Calendar.EventInstanceAttributes`. Every resource also has `id` and `type` (`'EventInstance'`) next to its attributes.

| Name | Type | Description |
| --- | --- | --- |
| `all_day_event` | `boolean \| null` | Indicates whether event instance lasts all day |
| `canceled` | `boolean \| null` | Indicates whether the event instance is canceled |
| `canceled_at` | `string \| null` | UTC time at which the event instance was canceled. `null` when it is not canceled |
| `church_center_url` | `string \| null` | The URL for the event on Church Center |
| `compact_recurrence_description` | `string \| null` | Compact representation of event instance's recurrence pattern |
| `created_at` | `string \| null` | UTC time at which the event instance was created |
| `description` | `string \| null` | See [details](#description). |
| `ends_at` | `string \| null` | UTC time at which the event instance ends |
| `image_url` | `string \| null` | See [details](#image-url). |
| `kind` | `string \| null` | See [details](#kind). |
| `location` | `string \| null` | Representation of where the event instance takes place |
| `name` | `string \| null` | Name of event. Can be overridden for specific instances |
| `published_ends_at` | `string \| null` | Publicly visible end time |
| `published_starts_at` | `string \| null` | Publicly visible start time |
| `recurrence` | `string \| null` | For a recurring event instance, the interval of how often the event instance occurs |
| `recurrence_description` | `string \| null` | Longer description of the event instance's recurrence pattern |
| `starts_at` | `string \| null` | UTC time at which the event instance starts |
| `updated_at` | `string \| null` | UTC time at which the event instance was updated |

### Attribute details

#### `description` {#description}

A rich text public-facing summary of the event

Only available when requested with the `?fields` param

#### `image_url` {#image-url}

Path to where the event image is stored

Only available when requested with the `?fields` param

#### `kind` {#kind}

The type of event: `standard` or `blockout`

Only available when requested with the `?fields` param

## Relationships and includes

Side-load with `include()` (or `get({ include })`) and read with `related(resource, name)`: `event`, `event_times`, `resource_bookings`, `tags`.

| Relationship | Type | To | Includable |
| --- | --- | --- | --- |
| `event` | To one | [Event](/reference/calendar/event/) | 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` |
| `ends_at` | `string \| Date` | `gt`, `gte`, `lt`, `lte` |
| `kind` | `string` | Equality only |
| `starts_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: `created_at`, `ends_at`, `starts_at`, `updated_at`.

### Filters

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

| Edge | Filters |
| --- | --- |
| `pco.calendar.event_instances` | `all`, `approved`, `approved_conflict`, `approved_pending`, `approved_pending_conflict`, `approved_pending_rejected`, `approved_pending_rejected_conflict`, `approved_rejected`, `approved_rejected_conflict`, `approver`, `approver_subscriber`, `canceled`, `conflict`, `event_request_approved`, `event_request_approved_pending`, `event_request_approved_pending_rejected`, `event_request_approved_rejected`, `event_request_pending`, `event_request_pending_rejected`, `event_request_rejected`, `future`, `lost`, `lost_due_to_blockout`, `manager`, `manager_approver`, `manager_approver_subscriber`, `manager_subscriber`, `not_canceled`, `not_pending_event_requests`, `owner`, `owner_approver`, `owner_approver_subscriber`, `owner_manager`, `owner_manager_approver`, `owner_manager_approver_subscriber`, `owner_manager_subscriber`, `owner_subscriber`, `pending`, `pending_conflict`, `pending_rejected`, `pending_rejected_conflict`, `rejected`, `rejected_conflict`, `shared`, `subscriber`, `unresolved` |
| `event_instances` on [Event](/reference/calendar/event/) | `canceled`, `future`, `not_canceled` |
| `event_instances` on [Tag](/reference/calendar/tag/) | `canceled`, `not_canceled` |

## Edges

Follow these from one EventInstance, `ref = pco.calendar.event_instances.id(eventInstanceId)`:

| Edge | Leads to | Returns | Filters | Create |
| --- | --- | --- | --- | --- |
| `ref.event` | [Event](/reference/calendar/event/) | Collection |  | No |
| `ref.event_times` | [EventTime](/reference/calendar/event-time/) | Collection |  | No |
| `ref.resource_bookings` | [ResourceBooking](/reference/calendar/resource-booking/) | Collection | `future`, `resources`, `rooms` | No |
| `ref.tags` | [Tag](/reference/calendar/tag/) | Collection |  | No |

## Writing

| Property | Value |
| --- | --- |
| Create | No |
| Update | No |
| Delete | No |

## Example

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

const page = await pco.calendar.event_instances.order('created_at').perPage(25).list();
const items: Calendar.EventInstance[] = page.data;
```

Source: https://planningcenterkit.mackenly.com/reference/calendar/event-instance/index.mdx
