A room or resource that can be requested for use as part of an event.
| Property | Value |
|---|---|
| Product | Calendar (pco.calendar, API version 2026-06-22) |
| Resource type | Resource |
| TypeScript | Calendar.Resource, attributes Calendar.ResourceAttributes, schema Calendar.ResourceSchema |
| Planning Center path | /calendar/v2/resources |
| Planning Center docs | Resource |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.calendar.resources |
Collection | resources, rooms |
Yes |
pco.calendar.conflicts.id(conflictId).resource |
Collection | No | |
pco.calendar.event_resource_requests.id(eventResourceRequestId).resource |
Collection | No | |
pco.calendar.resource_approval_groups.id(resourceApprovalGroupId).required_approvals.id(requiredApprovalId).resource |
Collection | No | |
pco.calendar.resource_approval_groups.id(resourceApprovalGroupId).resources |
Collection | resources, rooms |
No |
pco.calendar.resource_bookings.id(resourceBookingId).resource |
Collection | No | |
pco.calendar.resource_folders.id(resourceFolderId).resources |
Collection | No | |
pco.calendar.room_setups.id(roomSetupId).resource_suggestions.id(resourceSuggestionId).resource |
Collection | No |
From a collection, .id(resourceId) addresses one Resource: pco.calendar.resources.id(resourceId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Calendar.ResourceAttributes. Every resource also has id and type ('Resource') next to its attributes.
| Name | Type | Description |
|---|---|---|
created_at |
string | null |
UTC time at which the room or resource was created |
description |
string | null |
Description of the room or resource |
expires_at |
string | null |
UTC time at which the resource expires |
home_location |
string | null |
Where the resource is normally kept |
image |
string | null |
Path to where resource image is stored |
kind |
string | null |
The type of resource, can either be Room or Resource |
name |
string | null |
The name of the room or resource |
path_name |
string | null |
See details. |
quantity |
number | null |
The quantity of the resource |
serial_number |
string | null |
The serial number of the resource |
updated_at |
string | null |
UTC time at which the room or resource was updated |
Attribute details
path_name
A string representing the location of the resource if it is nested within a folder.
Each parent folder is separated by /
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): resource_approval_groups, resource_folder, resource_questions, room_setups.
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 |
id |
string |
Equality only |
kind |
string |
Equality only |
name |
string |
Equality only |
path_name |
string |
Equality only |
serial_number |
string |
Equality only |
updated_at |
string | Date |
gt, gte, lt, lte |
Order
order(...) accepts these fields, ascending, or descending with a - prefix: created_at, expires_at, name, updated_at.
Filters
filter(...) names depend on the edge you query through:
| Edge | Filters |
|---|---|
pco.calendar.resources |
resources, rooms |
resources on ResourceApprovalGroup |
resources, rooms |
Edges
Follow these from one Resource, ref = pco.calendar.resources.id(resourceId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.conflicts |
Conflict | Collection | No | |
ref.event_resource_requests |
EventResourceRequest | Collection | No | |
ref.required_approvals |
RequiredApproval | Collection | No | |
ref.resource_approval_groups |
ResourceApprovalGroup | Collection | No | |
ref.resource_bookings |
ResourceBooking | Collection | approved, approved_conflict, approved_pending, approved_pending_conflict, approved_pending_rejected, approved_pending_rejected_conflict, approved_rejected, approved_rejected_conflict, conflict, future, pending, pending_conflict, pending_rejected, pending_rejected_conflict, rejected, rejected_conflict |
No |
ref.resource_folder |
ResourceFolder | Collection | No | |
ref.resource_questions |
ResourceQuestion | Collection | Yes | |
ref.room_setups |
RoomSetup | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | Yes, create() on pco.calendar.resources |
| Update | Yes, update() on a reference |
| Delete | Yes, delete() on a reference |
Create attributes
Typed as Calendar.ResourceSchema['create'].
| Attribute | Type |
|---|---|
description |
string | null |
expires_at |
string | null |
home_location |
string | null |
kind |
string | null |
name |
string | null |
quantity |
number | null |
resource_approval_group_ids |
string[] |
resource_folder_id |
string |
room_setup_ids |
string[] |
serial_number |
string | null |
Update attributes
Typed as Calendar.ResourceSchema['update'].
| Attribute | Type |
|---|---|
description |
string | null |
expires_at |
string | null |
home_location |
string | null |
name |
string | null |
quantity |
number | null |
resource_approval_group_ids |
string[] |
resource_folder_id |
string |
serial_number |
string | null |
See Writing data.
Example
import type { Calendar } from '@mackenly/planningcenterkit';
const page = await pco.calendar.resources.order('created_at').perPage(25).list();
const items: Calendar.Resource[] = page.data;