Skip to content

Option (Check-Ins)

An option which an attendee may select when checking in.

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

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; 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 Collection No
ref.label Label Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

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

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

Type to search…

↑↓ navigate↵ selectEsc close