 API: Rental Calendar
Facility rental bookings with renter details. Defaults to today through the next 90 days; All=1 lists every booking with no date window. The response also includes a rentalTypes array for mapping TypeID.
Calling the Endpoint
| HTTP Request Type | GET |
| Calling URI | https://www.YourDepartment.com/apps/api/rental/ |
| Request Header | Authorization: Bearer {access_token} |
Parameters
| Parameter | Description |
ID |
Optional. A single booking ID. Returned regardless of its dates. |
TypeID |
Optional. Limit to one rental type (the typeId value). |
All |
Optional. 1 = list every booking with no date window. |
StartDate |
Optional. Start of the date range; bookings overlapping the range are returned. Default: today. |
EndDate |
Optional. End of the date range. Default: 90 days from today. |
Response Properties
| Property | Description |
id |
Booking ID (number) |
typeId |
Rental type ID (number) |
type |
Rental type name (string) |
startDate |
Booking start date (string, yyyy-mm-dd) |
endDate |
Booking end date (string, yyyy-mm-dd) |
allDay |
1 = all-day booking (number) |
startTime |
Start time when not all-day (string) |
endTime |
End time when not all-day (string) |
renter |
Renter name (string) |
renterPhone |
Renter phone number (string) |
details |
Booking details (string) |
Sample Request
GET https://www.YourDepartment.com/apps/api/rental/?MaxRows=1
Authorization: Bearer {access_token}
Sample Response
{
"status": 200,
"endpoint": "rental",
"domain": "www.YourDepartment.com",
"generated": "2026-09-06 09:15:00",
"startRow": 1,
"maxRows": 1,
"count": 1,
"totalCount": 9,
"startDate": "2026-09-06",
"endDate": "2026-12-05",
"rentalTypes": [
{ "id": 1, "type": "Main Hall" },
{ "id": 2, "type": "Pavilion" }
],
"items": [
{
"id": 448,
"typeId": 1,
"type": "Main Hall",
"startDate": "2026-09-19",
"endDate": "2026-09-19",
"allDay": 0,
"startTime": "16:00:00",
"endTime": "23:00:00",
"renter": "Susan Carter",
"renterPhone": "301-555-0187",
"details": "Wedding reception, 120 guests."
}
]
}
Records are returned in the items array. count is the
number of records in this response; totalCount is all matching records regardless of paging. Page with
StartRow and MaxRows (default 100, maximum 1000) until count + startRow exceeds totalCount.
Back to the API Documentation
|
September 21, 2026: