My Developer Account

ResourceFolder

An organizational folder containing rooms or resources.

Example Request 

curl https://api.planningcenteronline.com/calendar/v2/resource_folders

View in API Explorer →

Example Object 

{
  "type": "ResourceFolder",
  "id": "1",
  "attributes": {
    "ancestry": "string",
    "created_at": "2000-01-01T12:00:00Z",
    "kind": "string",
    "name": "string",
    "path": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "resource_folder": {
      "data": {
        "type": "ResourceFolder",
        "id": "1"
      }
    }
  }
}

Attributes

Name Type Description
ancestry string
created_at date_time

UTC time at which the folder was created
id primary_key

Unique identifier for the folder
kind string

The type of folder, can either be Room or Resource
name string

The folder name
path string
updated_at date_time

UTC time at which the folder was updated

Relationships

Name Type Association Type Note
resource_folder ResourceFolder to_one

Can Include

Parameter Value Description Assignable
include resources

include associated resources

Order By

Parameter Value Type Description
order ancestry string

prefix with a hyphen (-ancestry) to reverse the order
order created_at string

prefix with a hyphen (-created_at) to reverse the order
order name string

prefix with a hyphen (-name) to reverse the order
order updated_at string

prefix with a hyphen (-updated_at) to reverse the order

Query By

Name Parameter Type Description Example
ancestry where[ancestry] string

Query on a specific ancestry

 ?where[ancestry]=string
created_at where[created_at] date_time

Query on a specific created_at

 ?where[created_at]=2000-01-01T12:00:00Z
name where[name] string

Query on a specific name

 ?where[name]=string
updated_at where[updated_at] date_time

Query on a specific updated_at

 ?where[updated_at]=2000-01-01T12:00:00Z

Pagination

Name Parameter Type Description
per_page per_page integer

how many records to return per page (min=1, max=100, default=25)
offset offset integer

get results from given offset

Endpoints

Listing

HTTP Method Endpoint
GET /calendar/v2/resource_folders

Reading

HTTP Method Endpoint
GET /calendar/v2/resource_folders/{id}

Creating

HTTP Method Endpoint Assignable Attributes
POST /calendar/v2/resource_folders
  • kind
  • name
  • resource_folder_id

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /calendar/v2/resource_folders/{id}
  • name
  • resource_folder_id

Deleting

HTTP Method Endpoint
DELETE /calendar/v2/resource_folders/{id}

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/calendar/v2/resource_folders/{resource_folder_id}/resources Resource

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/calendar/v2/resource_folders Organization
  • resources
  • rooms
GET https://api.planningcenteronline.com/calendar/v2/resources/{resource_id}/resource_folder Resource