Skip to content

EventLabel (Check-Ins)

Says how many of a given label to print for this event and whether to print it for regulars, guests, and/or volunteers.

Says how many of a given label to print for this event and whether to print it for regulars, guests, and/or volunteers.

Property Value
Product Check-Ins (pco.checkIns, API version 2025-05-28)
Resource type EventLabel
TypeScript CheckIns.EventLabel, attributes CheckIns.EventLabelAttributes, schema CheckIns.EventLabelSchema
Planning Center path /check-ins/v2/events/{event_id}/event_labels
Planning Center docs EventLabel

How to reach it

Client path Returns Filters Create
pco.checkIns.events.id(eventId).event_labels Collection No
pco.checkIns.labels.id(labelId).event_labels Collection No

From a collection, .id(eventLabelId) addresses one EventLabel: pco.checkIns.events.id(eventId).event_labels.id(eventLabelId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On CheckIns.EventLabelAttributes. Every resource also has id and type ('EventLabel') next to its attributes.

Name Type Description
created_at string | null
for_guest boolean | null
for_regular boolean | null
for_volunteer boolean | null
quantity number | null
updated_at string | null

Relationships and includes

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

Querying

No documented where fields.

No documented order fields.

Edges

Follow these from one EventLabel, ref = pco.checkIns.events.id(eventId).event_labels.id(eventLabelId):

Edge Leads to Returns Filters Create
ref.event Event Collection No
ref.label Label Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

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

const eventId = '1'; // Event id

const page = await pco.checkIns.events.id(eventId).event_labels.perPage(25).list();
const items: CheckIns.EventLabel[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close