Skip to content

RoomSetup (Calendar)

A diagram and list of suggested resources useful for predefined room setups.

A diagram and list of suggested resources useful for predefined room setups.

Property Value
Product Calendar (pco.calendar, API version 2026-06-22)
Resource type RoomSetup
TypeScript Calendar.RoomSetup, attributes Calendar.RoomSetupAttributes, schema Calendar.RoomSetupSchema
Planning Center path /calendar/v2/room_setups
Planning Center docs RoomSetup

How to reach it

Client path Returns Filters Create
pco.calendar.room_setups Collection shared_room_setups No
pco.calendar.event_resource_requests.id(eventResourceRequestId).room_setup Collection No
pco.calendar.resources.id(resourceId).room_setups Collection No

From a collection, .id(roomSetupId) addresses one RoomSetup: pco.calendar.room_setups.id(roomSetupId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Calendar.RoomSetupAttributes. Every resource also has id and type ('RoomSetup') next to its attributes.

Name Type Description
created_at string | null UTC time at which the room setup was created
description string | null A description of the room setup
diagram string | null See details.
diagram_thumbnail_url string | null Path to where thumbnail version of room setup is stored
diagram_url string | null Path to where room setup is stored
name string | null The name of the room setup
updated_at string | null UTC time at which the room setup was updated

Attribute details

diagram

An object containing url and thumbnail.

url is path to where room setup is stored. thumbnail contains url path to where thumbnail is stored.

Relationships and includes

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

Relationship Type To Includable
containing_resource To one Resource Yes
resource_suggestions To many ResourceSuggestion Yes
room_setup To one RoomSetup No

Querying

Where

where(field, value) for equality; where(field, op, value) with the operators listed.

Field Value type Operators
created_at string | Date gt, gte, lt, lte
name string Equality only
updated_at string | Date gt, gte, lt, lte

Order

order(...) accepts these fields, ascending, or descending with a - prefix: created_at, name, updated_at.

Filters

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

Edge Filters
pco.calendar.room_setups shared_room_setups

Edges

Follow these from one RoomSetup, ref = pco.calendar.room_setups.id(roomSetupId):

Edge Leads to Returns Filters Create
ref.containing_resource ContainingResource Collection No
ref.resource_suggestions ResourceSuggestion Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

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

const page = await pco.calendar.room_setups.order('created_at').perPage(25).list();
const items: Calendar.RoomSetup[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close