---
title: "EventPeriod (Check-Ins)"
description: "A recurrence of an event, sometimes called a \"session\"."
---

> 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.

# EventPeriod (Check-Ins)

A recurrence of an event, sometimes called a "session".
For weekly events, an event period is a week. For daily events, an event period is a day.
An event period has event times, which is what people select
when they actually check in. When new sessions are created, times
are copied from one session to the next.

| Property | Value |
| --- | --- |
| Product | [Check-Ins](/reference/check-ins/) (`pco.checkIns`, API version `2025-05-28`) |
| Resource type | `EventPeriod` |
| TypeScript | `CheckIns.EventPeriod`, attributes `CheckIns.EventPeriodAttributes`, schema `CheckIns.EventPeriodSchema` |
| Planning Center path | `/check-ins/v2/check_ins/{check_in_id}/event_period` |
| Planning Center docs | [EventPeriod](https://api.planningcenteronline.com/docs/apps/check-ins/versions/2025-05-28/vertices/event_period) |

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.checkIns.check_ins.id(checkInId).event_period` | Collection |  | No |
| `pco.checkIns.check_ins.id(checkInId).check_in_group.id(checkInGroupId).event_period` | Collection |  | No |
| `pco.checkIns.events.id(eventId).event_periods` | Collection |  | No |
| `pco.checkIns.event_times.id(eventTimeId).event_period` | Collection |  | No |
| `pco.checkIns.check_ins.id(checkInId).event_period.id(eventPeriodId).location_event_periods.id(locationEventPeriodId).event_period` | Collection |  | No |

From a collection, `.id(eventPeriodId)` addresses one EventPeriod: `pco.checkIns.check_ins.id(checkInId).event_period.id(eventPeriodId)`. Collections support [`where`, `include`, `order`, and pagination](/guides/querying/); single resources have `get()`.

## Attributes

On `CheckIns.EventPeriodAttributes`. Every resource also has `id` and `type` (`'EventPeriod'`) next to its attributes.

| Name | Type | Description |
| --- | --- | --- |
| `created_at` | `string \| null` |  |
| `ends_at` | `string \| null` |  |
| `guest_count` | `number \| null` |  |
| `note` | `string \| null` |  |
| `regular_count` | `number \| null` |  |
| `starts_at` | `string \| null` |  |
| `unique_guest_count` | `number \| null` | See [details](#unique-guest-count). |
| `unique_regular_count` | `number \| null` | See [details](#unique-regular-count). |
| `unique_total_count` | `number \| null` | See [details](#unique-total-count). |
| `unique_volunteer_count` | `number \| null` | See [details](#unique-volunteer-count). |
| `updated_at` | `string \| null` |  |
| `volunteer_count` | `number \| null` |  |

### Attribute details

#### `unique_guest_count` {#unique-guest-count}

Deduplicated people with a Guest check-in.

Only available when requested with the `?fields` param

#### `unique_regular_count` {#unique-regular-count}

Deduplicated people with a Regular check-in.

Only available when requested with the `?fields` param

#### `unique_total_count` {#unique-total-count}

Deduplicated people with any check-in.

Only available when requested with the `?fields` param

#### `unique_volunteer_count` {#unique-volunteer-count}

Deduplicated people with a Volunteer check-in.

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`.

| Relationship | Type | To | Includable |
| --- | --- | --- | --- |
| `event` | To one | [Event](/reference/check-ins/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` |
| `starts_at` | `string \| Date` | `gt`, `gte`, `lt`, `lte` |

### Order

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

## Edges

Follow these from one EventPeriod, `ref = pco.checkIns.check_ins.id(checkInId).event_period.id(eventPeriodId)`:

| Edge | Leads to | Returns | Filters | Create |
| --- | --- | --- | --- | --- |
| `ref.check_ins` | [CheckIn](/reference/check-ins/check-in/) | Collection | `attendee`, `checked_out`, `first_time`, `guest`, `not_checked_out`, `not_one_time_guest`, `one_time_guest`, `regular`, `volunteer` | No |
| `ref.event` | [Event](/reference/check-ins/event/) | Collection |  | No |
| `ref.event_times` | [EventTime](/reference/check-ins/event-time/) | Collection | `available` | No |
| `ref.location_event_periods` | [LocationEventPeriod](/reference/check-ins/location-event-period/) | Collection |  | No |

## Writing

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

## Example

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

const checkInId = '1'; // CheckIn id

const page = await pco.checkIns.check_ins.id(checkInId).event_period.order('starts_at').perPage(25).list();
const items: CheckIns.EventPeriod[] = page.data;
```

Source: https://planningcenterkit.mackenly.com/reference/check-ins/event-period/index.mdx
