List Reservations
GET /reservationssite
This endpoint is optimized for retrieving multiple reservations at once and as a result may not have all fields fully populated. To retrieve a full reservation, you can request it via the "Get Single Reservation" endpoint using the reservation_id.
Query Parameters
Repeat reservable_ids, reservable_site_ordinal_ids, reservation_ids, statuses, or tags to pass multiple values. The [] forms are also accepted.
| Parameter | Type | Default | Description |
|---|---|---|---|
and_requests |
boolean | false |
Whether to include requests in addition to reservations |
barcode |
string | "" |
Filter by barcode |
category |
string | "" |
Filter by category (does substring matching on display category field) |
current_only |
boolean | false |
Only return current reservations (happening at the time of the request) |
end |
string | "" |
Filter by end date/time |
end_unix |
integer | Omitted | Filter by end Unix timestamp |
filter_time |
string | "" |
How to filter by time - blank means any overlap, 'start' means starts in filtered times, and 'end' means end in filtered times |
for_logged_in_user |
boolean | false |
Whether to filter by the currently logged-in user |
for_site_calendar |
boolean | false |
Whether to return data for a site calendar (may have different fields) |
include_approvals |
boolean | false |
Whether to include approvals in the response |
include_autocancelled |
boolean | false |
Whether to include autocanceled reservations |
include_blocked |
boolean | true |
Whether to include resources that each reservation blocks |
include_cancelled |
boolean | false |
Whether to include canceled reservations |
include_cancelled_and_edited |
boolean | false |
Whether to include both canceled and edited reservations |
include_checked_in |
boolean | true |
Whether to include reservations that are explicitly checked into or out of |
include_checked_in_status |
boolean | true |
Whether to include the checked-in status of reservables |
include_events |
boolean | false |
Whether to include events in the response |
include_event_requests |
boolean | true |
Whether to include event requests |
include_filtered_user_if_guest |
boolean | true |
Whether to include a filtered user if they are a guest |
include_form_responses |
boolean | false |
Whether to include form responses in the response |
include_ical_feeds |
boolean | true |
Whether to include iCal feed reservations |
include_maintenance |
boolean | false |
Whether to include maintenance reservables |
include_maintenance_nonblocking |
boolean | false |
Whether to include non-blocking maintenance reservables |
include_not_checked_in |
boolean | true |
Whether to include not checked-in reservables |
include_paid_status |
boolean | false |
Whether to include paid status in the response |
include_projects |
boolean | true |
Whether to include projects in the response |
include_soft |
boolean | true |
Whether to include soft reservables |
include_templates |
boolean | false |
Whether to include templates in the response |
invoice_id |
string | "" |
Filter by invoice ID |
is_loan |
boolean | Omitted | Whether to filter by loan status |
is_returned |
boolean | Omitted | Whether to filter by returned status |
is_overdue |
boolean | Omitted | Whether to filter by overdue status |
limit |
integer | none |
Limit the number of results |
offset |
integer | 0 |
The offset of the first item in the result set |
only_events |
boolean | false |
Whether to only return events |
only_maintenance |
boolean | false |
Whether to only return maintenance reservations |
only_soft |
boolean | false |
Whether to only return soft reservations |
only_templates |
boolean | false |
Whether to only return template reservations |
order_by_attr |
string | null |
The attribute to order the results by |
order_by_desc |
boolean | false |
Whether to order the results in descending order |
paid_status |
boolean | Omitted | Whether to only return paid reservations |
pinned_to_project |
boolean | false |
Whether to only return reservations pinned to a project |
portal_id |
string | null |
The ID of the portal to filter by |
project_id |
string | null |
The ID of the project to filter by |
qclass |
string | null |
The class of the reservations to filter by |
rate_requests_only |
boolean | false |
Whether to only return rate requests |
read_only |
boolean | false |
Whether the reservation is read-only |
recurring_reservation_id |
string | null |
The ID of the recurring reservation to filter by |
requests_only |
boolean | false |
Whether to only return requests |
requests_time_filter_attr |
string | null |
An attribute to filter request time by |
reservable_id |
string | null |
The ID of the reservable item to filter by |
reservable_ids |
array | [] |
A list of IDs of reservable items to filter by |
reservable_site_ordinal_ids |
array | [] |
A list of site ordinal IDs of reservable items to filter by |
reservation_ids |
array | [] |
A list of IDs of reservations to filter by |
return_count |
boolean | false |
Whether to return the count of results |
return_only_count |
boolean | false |
Whether to only return the count of results |
search_form_responses |
string | null |
A query to search form responses by |
search_reservation |
string | null |
A query to search reservations by |
site_id |
string | null |
The ID of the site to filter by |
start |
string | null |
The start date of the reservations to filter by |
start_unix |
integer | none |
The start time of the reservations to filter by in Unix format |
statuses |
array | [] |
A list of statuses to filter by |
supervisor_id |
string | null |
The ID of the supervisor to filter by |
tags |
array | [] |
A list of tags to filter by |
user_id |
string | null |
The ID of the user to filter by |
usergroup_id |
integer | none |
The ID of the user group to filter by |
verbose_checked_in |
boolean | false |
Whether to return verbose checked-in information |
Response
Success Response (200 OK)
data contains the matching reservation objects. return_count=true includes the total match count in numitems. With return_only_count=true, data is the count as an integer. See Reservation Object for the shared response fields.
Error Responses
400 Bad Request: Invalid request or validation error401 Unauthorized: Authentication failed
See the Reservations API overview for related endpoints and shared data structures.