---
title: "Check-Ins reference"
description: "Planning Center Check-Ins in Planning Center Kit: Events, check-ins, locations, stations, labels, passes, and headcounts."
---

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

# Check-Ins reference

Events, check-ins, locations, stations, labels, passes, and headcounts.

| Property | Value |
| --- | --- |
| Client property | `pco.checkIns` |
| Subpath import | `import { createCheckInsClient } from '@mackenly/planningcenterkit/check-ins'` |
| Types namespace | `CheckIns` |
| Base path | `/check-ins/v2` |
| Pinned API version | `2025-05-28` |
| Resource types | 24 |
| Planning Center docs | [Planning Center Check-Ins API](https://api.planningcenteronline.com/docs/apps/check-ins/versions/2025-05-28) |

Each product client sends `X-PCO-API-Version: 2025-05-28`, the version these types were generated from. Override it with `new PlanningCenter({ auth, versions: { checkIns: '...' } })`; the types won't follow. See [Products](/guides/products/).

```ts
import { createCheckInsClient } from '@mackenly/planningcenterkit/check-ins';

const checkIns = createCheckInsClient({ auth: { applicationId: process.env.PCO_APP_ID!, secret: process.env.PCO_SECRET! } });
const { data: root } = await checkIns.get(); // /check-ins/v2
```

## Root collections

Properties on `pco.checkIns`, named after their URL. `pco.checkIns.get()` fetches the product root (`/check-ins/v2`), and `pco.checkIns.edge(name)` follows any root edge by name.

| Client path | Resource | Returns | Filters | Create |
| --- | --- | --- | --- | --- |
| `pco.checkIns.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 |
| `pco.checkIns.event_times` | [EventTime](/reference/check-ins/event-time/) | Collection |  | No |
| `pco.checkIns.events` | [Event](/reference/check-ins/event/) | Collection | `archived`, `for_campus`, `for_headcounts`, `for_registrations`, `not_archived` | No |
| `pco.checkIns.headcounts` | [Headcount](/reference/check-ins/headcount/) | Collection |  | No |
| `pco.checkIns.integration_links` | [IntegrationLink](/reference/check-ins/integration-link/) | Collection |  | No |
| `pco.checkIns.labels` | [Label](/reference/check-ins/label/) | Collection |  | No |
| `pco.checkIns.options` | [Option](/reference/check-ins/option/) | Collection |  | No |
| `pco.checkIns.passes` | [Pass](/reference/check-ins/pass/) | Collection |  | No |
| `pco.checkIns.people` | [Person](/reference/check-ins/person/) | Collection |  | No |
| `pco.checkIns.stations` | [Station](/reference/check-ins/station/) | Collection |  | No |
| `pco.checkIns.themes` | [Theme](/reference/check-ins/theme/) | Collection |  | No |

## Resources

| Resource | TypeScript | Description |
| --- | --- | --- |
| [AttendanceType](/reference/check-ins/attendance-type/) | `CheckIns.AttendanceType` | A kind of attendee which is tracked by headcount, not by check-in. |
| [CheckIn](/reference/check-ins/check-in/) | `CheckIns.CheckIn` | An attendance record for an event. |
| [CheckInGroup](/reference/check-ins/check-in-group/) | `CheckIns.CheckInGroup` | When one or more people check in, they're grouped in a CheckInGroup. |
| [CheckInTime](/reference/check-ins/check-in-time/) | `CheckIns.CheckInTime` | A CheckInTime combines an EventTime and a Location, and associates it with the parent CheckIn. |
| [Event](/reference/check-ins/event/) | `CheckIns.Event` | A recurring event which people may attend. |
| [EventLabel](/reference/check-ins/event-label/) | `CheckIns.EventLabel` | Says how many of a given label to print for this event and whether to print it for regulars, guests, and/or volunteers. |
| [EventPeriod](/reference/check-ins/event-period/) | `CheckIns.EventPeriod` | A recurrence of an event, sometimes called a "session". |
| [EventTime](/reference/check-ins/event-time/) | `CheckIns.EventTime` | A time that someone may check in. |
| [Headcount](/reference/check-ins/headcount/) | `CheckIns.Headcount` | A tally of attendees for a given event time and attendance type. |
| [IntegrationLink](/reference/check-ins/integration-link/) | `CheckIns.IntegrationLink` | A record linking another product's resource to a Check-Ins resource. |
| [Label](/reference/check-ins/label/) | `CheckIns.Label` | Labels can be set to print for events (through EventLabels), locations (through LocationLabels) or options. |
| [Location](/reference/check-ins/location/) | `CheckIns.Location` | A place where people may check in to for a given event. |
| [LocationEventPeriod](/reference/check-ins/location-event-period/) | `CheckIns.LocationEventPeriod` | Counts check-ins for a location during a certain event period. |
| [LocationEventTime](/reference/check-ins/location-event-time/) | `CheckIns.LocationEventTime` | Counts check-ins for a location for a given event time. |
| [LocationLabel](/reference/check-ins/location-label/) | `CheckIns.LocationLabel` | Says how many of a given label to print for this location and whether to print it for regulars, guests, and/or volunteers. |
| [Option](/reference/check-ins/option/) | `CheckIns.Option` | An option which an attendee may select when checking in. |
| [Organization](/reference/check-ins/organization/) | `CheckIns.Organization` | An organization which has people and events. |
| [Pass](/reference/check-ins/pass/) | `CheckIns.Pass` | Enables quick lookup of a person via barcode reader. |
| [Person](/reference/check-ins/person/) | `CheckIns.Person` | An attendee, volunteer or administrator. |
| [PersonEvent](/reference/check-ins/person-event/) | `CheckIns.PersonEvent` | Counts a person's attendence for a given event. |
| [PreCheck](/reference/check-ins/pre-check/) | `CheckIns.PreCheck` |  |
| [RosterListPerson](/reference/check-ins/roster-list-person/) | `CheckIns.RosterListPerson` |  |
| [Station](/reference/check-ins/station/) | `CheckIns.Station` | A device where people can be checked in. |
| [Theme](/reference/check-ins/theme/) | `CheckIns.Theme` | A custom style which may be applied to stations. |

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