API
⌘K
My Developer Account

Resource

A room or resource that can be requested for use as part of an event.

Example Request

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

View in API Explorer →

Example Object

{
  "type": "Resource",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "description": "string",
    "expires_at": "2000-01-01T12:00:00Z",
    "home_location": "string",
    "image": "string",
    "kind": "string",
    "name": "string",
    "path_name": "string",
    "quantity": 1,
    "serial_number": "string",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {}
}

Attributes

Name Type Description
created_at date_time UTC time at which the room or resource was created
description string Description of the room or resource
expires_at date_time UTC time at which the resource expires
home_location string Where the resource is normally kept
id primary_key Unique identifier for the room or resource
image string Path to where resource image is stored
kind string The type of resource, can either be `Room` or `Resource`
name string The name of the room or resource
path_name string A string representing the location of the resource if it is nested within a folder. Each parent folder is separated by `/`
quantity integer The quantity of the resource
serial_number string The serial number of the resource
updated_at date_time UTC time at which the room or resource was updated

Can Include

Parameter Value Description Assignable
include resource_approval_groups include associated resource_approval_groups
include resource_folder include associated resource_folder create and update
include resource_questions include associated resource_questions
include room_setups include associated room_setups

Order By

Parameter Value Type Description
order created_at string prefix with a hyphen (-created_at) to reverse the order
order expires_at string prefix with a hyphen (-expires_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
created_at where[created_at] date_time Query on a specific created_at ?where[created_at]=2000-01-01T12:00:00Z
kind where[kind] string Query on a specific kind ?where[kind]=string
name where[name] string Query on a specific name ?where[name]=string
path_name where[path_name] string Query on a specific path_name ?where[path_name]=string
serial_number where[serial_number] string Query on a specific serial_number ?where[serial_number]=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/resources

Reading

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

Creating

HTTP Method Endpoint Assignable Attributes
POST /calendar/v2/resources
  • kind
  • description
  • expires_at
  • home_location
  • name
  • quantity
  • serial_number

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /calendar/v2/resources/{id}
  • description
  • expires_at
  • home_location
  • name
  • quantity
  • serial_number

Deleting

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

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/calendar/v2/resources/{resource_id}/conflicts Conflict
GET https://api.planningcenteronline.com/calendar/v2/resources/{resource_id}/event_resource_requests EventResourceRequest
GET https://api.planningcenteronline.com/calendar/v2/resources/{resource_id}/required_approvals RequiredApproval
GET https://api.planningcenteronline.com/calendar/v2/resources/{resource_id}/resource_approval_groups ResourceApprovalGroup
GET https://api.planningcenteronline.com/calendar/v2/resources/{resource_id}/resource_bookings ResourceBooking
  • approved
  • approved_pending
  • approved_pending_rejected
  • approved_rejected
  • future
  • pending
  • pending_rejected
  • rejected
GET https://api.planningcenteronline.com/calendar/v2/resources/{resource_id}/resource_folder ResourceFolder
GET https://api.planningcenteronline.com/calendar/v2/resources/{resource_id}/resource_questions ResourceQuestion
GET https://api.planningcenteronline.com/calendar/v2/resources/{resource_id}/room_setups RoomSetup

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/calendar/v2/conflicts/{conflict_id}/resource Conflict
GET https://api.planningcenteronline.com/calendar/v2/event_resource_requests/{event_resource_request_id}/resource EventResourceRequest
GET https://api.planningcenteronline.com/calendar/v2/resources Organization
  • resources
  • rooms
GET https://api.planningcenteronline.com/calendar/v2/resource_approval_groups/{resource_approval_group_id}/required_approvals/{required_approval_id}/resource RequiredApproval
GET https://api.planningcenteronline.com/calendar/v2/resource_approval_groups/{resource_approval_group_id}/resources ResourceApprovalGroup
  • resources
  • rooms
GET https://api.planningcenteronline.com/calendar/v2/resource_bookings/{resource_booking_id}/resource ResourceBooking
GET https://api.planningcenteronline.com/calendar/v2/resource_folders/{resource_folder_id}/resources ResourceFolder
GET https://api.planningcenteronline.com/calendar/v2/room_setups/{room_setup_id}/resource_suggestions/{resource_suggestion_id}/resource ResourceSuggestion