---
title: "CheckInGroup (Check-Ins)"
description: "When one or more people check in, they're grouped in a CheckInGroup."
---

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

# CheckInGroup (Check-Ins)

When one or more people check in, they're grouped in a `CheckInGroup`.
These check-ins all have the same "checked-in by" person.

| Property | Value |
| --- | --- |
| Product | [Check-Ins](/reference/check-ins/) (`pco.checkIns`, API version `2025-05-28`) |
| Resource type | `CheckInGroup` |
| TypeScript | `CheckIns.CheckInGroup`, attributes `CheckIns.CheckInGroupAttributes`, schema `CheckIns.CheckInGroupSchema` |
| Planning Center path | `/check-ins/v2/stations/{station_id}/check_in_groups` |
| Planning Center docs | [CheckInGroup](https://api.planningcenteronline.com/docs/apps/check-ins/versions/2025-05-28/vertices/check_in_group) |

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.checkIns.check_ins.id(checkInId).check_in_group` | Collection |  | No |
| `pco.checkIns.stations.id(stationId).check_in_groups` | Collection | `canceled`, `printed`, `ready`, `skipped` | No |

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

## Attributes

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

| Name | Type | Description |
| --- | --- | --- |
| `check_ins_count` | `number \| null` |  |
| `created_at` | `string \| null` |  |
| `name_labels_count` | `number \| null` |  |
| `print_status` | `string \| null` | See [details](#print-status). |
| `security_labels_count` | `number \| null` |  |
| `updated_at` | `string \| null` |  |

### Attribute details

#### `print_status` {#print-status}

Possible values:
  - `ready`: This group isn't printed or canceled yet
  - `printed`: This group was successfully printed at a station
  - `canceled`: This group was canceled at a station
  - `skipped`: This group had no labels to print, so it was never printed.

## Relationships and includes

Side-load with `include()` (or `get({ include })`) and read with `related(resource, name)`: `check_ins`, `event_period`, `print_station`.

## Querying

No documented `where` fields.

No documented `order` fields.

### Filters

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

| Edge | Filters |
| --- | --- |
| `check_in_groups` on [Station](/reference/check-ins/station/) | `canceled`, `printed`, `ready`, `skipped` |

## Edges

Follow these from one CheckInGroup, `ref = pco.checkIns.check_ins.id(checkInId).check_in_group.id(checkInGroupId)`:

| Edge | Leads to | Returns | Filters | Create |
| --- | --- | --- | --- | --- |
| `ref.check_ins` | [CheckIn](/reference/check-ins/check-in/) | Collection |  | No |
| `ref.event_period` | [EventPeriod](/reference/check-ins/event-period/) | Collection |  | No |
| `ref.print_station` | [Station](/reference/check-ins/station/) | 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).check_in_group.perPage(25).list();
const items: CheckIns.CheckInGroup[] = page.data;
```

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