ResourceBooking - Calendar API

Example Request

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

View in API Explorer →

Example Object

{
  "type": "ResourceBooking",
  "id": "1",
  "attributes": {
    "created_at": "2000-01-01T12:00:00Z",
    "ends_at": "2000-01-01T12:00:00Z",
    "quantity": 1,
    "starts_at": "2000-01-01T12:00:00Z",
    "updated_at": "2000-01-01T12:00:00Z"
  },
  "relationships": {
    "event": {
      "data": {
        "type": "Event",
        "id": "1"
      }
    },
    "event_instance": {
      "data": {
        "type": "EventInstance",
        "id": "1"
      }
    },
    "resource": {
      "data": {
        "type": "Resource",
        "id": "1"
      }
    }
  }
}

Attributes

Name	Type	Description
`created_at`	`date_time`	UTC time at which the booking was created
`ends_at`	`date_time`	UTC time at which usage of the booked room or resource ends
`id`	`primary_key`	Unique identifier for the booking
`quantity`	`integer`	The quantity of the rooms or resources booked
`starts_at`	`date_time`	UTC time at which usage of the booked room or resource starts
`updated_at`	`date_time`	UTC time at which the booking was updated

Relationships

Name	Type	Association Type
event	Event	to_one
event_instance	EventInstance	to_one
resource	Resource	to_one

Can Include

Parameter	Value	Description	Assignable
include	event_instance	include associated event_instance	create and update
include	event_resource_request	include associated event_resource_request
include	resource	include associated resource	create and update

Order By

Parameter	Value	Type	Description
order	created_at	string	prefix with a hyphen (-created_at) to reverse the order
order	ends_at	string	prefix with a hyphen (-ends_at) to reverse the order
order	starts_at	string	prefix with a hyphen (-starts_at) 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`
ends_at	`where[ends_at]`	date_time	Query on a specific ends_at	`?where[ends_at]=2000-01-01T12:00:00Z`
starts_at	`where[starts_at]`	date_time	Query on a specific starts_at	`?where[starts_at]=2000-01-01T12:00:00Z`
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_bookings`

Reading

HTTP Method	Endpoint
GET	`/calendar/v2/resource_bookings/{id}`

Associations

HTTP Method	Endpoint	Returns
GET	`https://api.planningcenteronline.com/calendar/v2/resource_bookings/{resource_booking_id}/event_instance`	EventInstance
GET	`https://api.planningcenteronline.com/calendar/v2/resource_bookings/{resource_booking_id}/event_resource_request`	EventResourceRequest
GET	`https://api.planningcenteronline.com/calendar/v2/resource_bookings/{resource_booking_id}/resource`	Resource

Belongs To

HTTP Method	Endpoint	Association	Filter By
GET	`https://api.planningcenteronline.com/calendar/v2/event_instances/{event_instance_id}/resource_bookings`	EventInstance	`future` `resources` `rooms`
GET	`https://api.planningcenteronline.com/calendar/v2/events/{event_id}/resource_bookings`	Event	`future`
GET	`https://api.planningcenteronline.com/calendar/v2/event_resource_requests/{event_resource_request_id}/resource_bookings`	EventResourceRequest	`approved` `approved_pending` `approved_pending_rejected` `approved_rejected` `future` `pending` `pending_rejected` `rejected`
GET	`https://api.planningcenteronline.com/calendar/v2/resource_bookings`	Organization	`approved` `approved_pending` `approved_pending_rejected` `approved_rejected` `future` `pending` `pending_rejected` `rejected` `resources` `rooms`
GET	`https://api.planningcenteronline.com/calendar/v2/resources/{resource_id}/resource_bookings`	Resource	`approved` `approved_pending` `approved_pending_rejected` `approved_rejected` `future` `pending` `pending_rejected` `rejected`