Skip to content

LocationLabel (Check-Ins)

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

Says how many of a given label to print for this location 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 LocationLabel
TypeScript CheckIns.LocationLabel, attributes CheckIns.LocationLabelAttributes, schema CheckIns.LocationLabelSchema
Planning Center path /check-ins/v2/labels/{label_id}/location_labels
Planning Center docs LocationLabel

How to reach it

Client path Returns Filters Create
pco.checkIns.labels.id(labelId).location_labels Collection No
pco.checkIns.check_ins.id(checkInId).locations.id(locationId).location_labels Collection No

From a collection, .id(locationLabelId) addresses one LocationLabel: pco.checkIns.labels.id(labelId).location_labels.id(locationLabelId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On CheckIns.LocationLabelAttributes. Every resource also has id and type ('LocationLabel') 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): label, location.

Querying

No documented where fields.

No documented order fields.

Edges

Follow these from one LocationLabel, ref = pco.checkIns.labels.id(labelId).location_labels.id(locationLabelId):

Edge Leads to Returns Filters Create
ref.label Label Collection No
ref.location Location Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

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

const labelId = '1'; // Label id

const page = await pco.checkIns.labels.id(labelId).location_labels.perPage(25).list();
const items: CheckIns.LocationLabel[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close