---
title: "Option (Check-Ins)"
description: "An option which an attendee may select when checking in."
---

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

# Option (Check-Ins)

An option which an attendee may select when checking in.

Options may have extra labels associated with them, denoted by `label` and `quantity`.

| Property | Value |
| --- | --- |
| Product | [Check-Ins](/reference/check-ins/) (`pco.checkIns`, API version `2025-05-28`) |
| Resource type | `Option` |
| TypeScript | `CheckIns.Option`, attributes `CheckIns.OptionAttributes`, schema `CheckIns.OptionSchema` |
| Planning Center path | `/check-ins/v2/options` |
| Planning Center docs | [Option](https://api.planningcenteronline.com/docs/apps/check-ins/versions/2025-05-28/vertices/option) |

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.checkIns.options` | Collection |  | No |
| `pco.checkIns.check_ins.id(checkInId).options` | Collection |  | No |
| `pco.checkIns.check_ins.id(checkInId).locations.id(locationId).options` | Collection |  | No |

From a collection, `.id(optionId)` addresses one Option: `pco.checkIns.options.id(optionId)`. Collections support [`where`, `include`, `order`, and pagination](/guides/querying/); single resources have `get()`.

## Attributes

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

| Name | Type | Description |
| --- | --- | --- |
| `body` | `string \| null` |  |
| `created_at` | `string \| null` |  |
| `quantity` | `number \| null` |  |
| `updated_at` | `string \| null` |  |

## Relationships and includes

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

## Querying

No documented `where` fields.

No documented `order` fields.

## Edges

Follow these from one Option, `ref = pco.checkIns.options.id(optionId)`:

| Edge | Leads to | Returns | Filters | Create |
| --- | --- | --- | --- | --- |
| `ref.check_ins` | [CheckIn](/reference/check-ins/check-in/) | Collection |  | No |
| `ref.label` | [Label](/reference/check-ins/label/) | Collection |  | No |

## Writing

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

## Example

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

const page = await pco.checkIns.options.perPage(25).list();
const items: CheckIns.Option[] = page.data;
```

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