Skip to content

ResourceFolder (Calendar)

An organizational folder containing rooms or resources.

An organizational folder containing rooms or resources.

Property Value
Product Calendar (pco.calendar, API version 2026-06-22)
Resource type ResourceFolder
TypeScript Calendar.ResourceFolder, attributes Calendar.ResourceFolderAttributes, schema Calendar.ResourceFolderSchema
Planning Center path /calendar/v2/resource_folders
Planning Center docs ResourceFolder

How to reach it

Client path Returns Filters Create
pco.calendar.resource_folders Collection resources, rooms Yes
pco.calendar.resources.id(resourceId).resource_folder Collection No

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

Attributes

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

Name Type Description
ancestry string | null
created_at string | null UTC time at which the folder was created
kind string | null The type of folder, can either be Room or Resource
name string | null The folder name
path_name string | null See details.
updated_at string | null UTC time at which the folder was updated

Attribute details

path_name

A string representing the location of the folder if it is nested.

Each parent folder is separated by /

Relationships and includes

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

Querying

Where

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

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

Order

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

Filters

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

Edge Filters
pco.calendar.resource_folders resources, rooms

Edges

Follow these from one ResourceFolder, ref = pco.calendar.resource_folders.id(resourceFolderId):

Edge Leads to Returns Filters Create
ref.resources Resource Collection No

Writing

Property Value
Create Yes, create() on pco.calendar.resource_folders
Update Yes, update() on a reference
Delete Yes, delete() on a reference

Create attributes

Typed as Calendar.ResourceFolderSchema['create'].

Attribute Type
kind string | null
name string | null
resource_folder_id string

Update attributes

Typed as Calendar.ResourceFolderSchema['update'].

Attribute Type
name string | null
resource_folder_id string

See Writing data.

Example

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

const page = await pco.calendar.resource_folders.order('ancestry').perPage(25).list();
const items: Calendar.ResourceFolder[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close