List facilities
Returns a paginated list of the spaces and resources members can book, with their booking rules and membership requirements. Filter by booking type, parent facility, archived state, or a free-text name search.
query Parameters
filter[type]filter[parent_id]filter[status]filter[query]includepage[number]page[size]Headers
X-Api-VersionOptional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.
List facilities › Responses
Paginated set of FacilityResource
current_pagefromlast_pageper_pagetototalCreate a facility
Creates a facility from name, description, and optional booking type, capacity, scheduling settings, visibility, and booking-form options. Other fields are ignored. Defaults to hidden from the public with public booking disabled and manager-only booking. API keys require facilities:write; session users require a facility manager or organization administrator role.
Headers
X-Api-VersionOptional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.
Create a facility › Request Body
namedescriptionpublicly_exposedpublicly_exposed_allow_bookingsmanager_onlytypecapacitybooking_intervalfuture_daysbasis_timebooking_request_deadlinepublicly_exposed_hide_user_namesprompt_for_booking_ownerprompt_for_adding_more_usersprompt_for_number_of_guestsuser_recurring_bookingsuser_specified_reasonCreate a facility › Responses
FacilityResource
idThe unique identifier of the facility.
namedescriptiontypeHow bookings are made: instant confirms immediately, request
needs a manager to approve.
parent_idThe id of the facility this one sits inside, or null when it is a top-level facility.
capacityThe maximum number of people the facility holds.
booking_intervalThe length in minutes of each bookable slot.
minimum_lengthThe shortest bookable duration, in hours.
maximum_lengthThe longest bookable duration, in hours.
future_daysHow many days ahead members may book.
basis_timeThe time of day booking slots are aligned from.
booking_request_deadlineHow many hours before the start time a booking request must be submitted.
booking_instructionsInstructions shown to members when they book.
user_recurring_bookingsWhether members may create repeating bookings themselves.
user_specified_reasonWhether members must give a reason when booking.
publicly_exposedWhether the facility's schedule is visible to the public.
publicly_exposed_allow_bookingsWhether the public schedule also accepts bookings.
publicly_exposed_hide_user_namesWhether the public schedule hides who made each booking.
manager_onlyWhether only managers may book the facility.
prompt_for_booking_ownerWhether the booking form asks who the booking is for.
prompt_for_adding_more_usersWhether the booking form asks for additional members to add.
prompt_for_number_of_guestsWhether the booking form asks how many guests are attending.
memberships_requiredStripe product ids of the memberships a member must hold to book, or null when the facility is open to everyone.
membership_requirement_modeWhether a member needs any one (or) or all (and) of
memberships_required.
statusWhether the facility is currently bookable or has been archived.
profile_imagesort_orderPosition of the facility in the manually ordered list.
archived_atISO 8601 timestamp of when the facility was archived, or null while it is active.
created_atISO 8601 timestamp of when the facility was created.
updated_atISO 8601 timestamp of when the facility was last changed.
The facility this one sits inside. Included when the parent
relation is requested.
childrenThe sub-facilities inside this one. Included when the children
relation is requested.
Get a facility
Returns a single space or resource with its booking rules and membership requirements. Archived facilities are returned as well as active ones.
path Parameters
facilityHeaders
X-Api-VersionOptional API version for this request. When omitted, the server uses the default version. This documentation describes version 2026-08-25.
Get a facility › Responses
FacilityResource
idThe unique identifier of the facility.
namedescriptiontypeHow bookings are made: instant confirms immediately, request
needs a manager to approve.
parent_idThe id of the facility this one sits inside, or null when it is a top-level facility.
capacityThe maximum number of people the facility holds.
booking_intervalThe length in minutes of each bookable slot.
minimum_lengthThe shortest bookable duration, in hours.
maximum_lengthThe longest bookable duration, in hours.
future_daysHow many days ahead members may book.
basis_timeThe time of day booking slots are aligned from.
booking_request_deadlineHow many hours before the start time a booking request must be submitted.
booking_instructionsInstructions shown to members when they book.
user_recurring_bookingsWhether members may create repeating bookings themselves.
user_specified_reasonWhether members must give a reason when booking.
publicly_exposedWhether the facility's schedule is visible to the public.
publicly_exposed_allow_bookingsWhether the public schedule also accepts bookings.
publicly_exposed_hide_user_namesWhether the public schedule hides who made each booking.
manager_onlyWhether only managers may book the facility.
prompt_for_booking_ownerWhether the booking form asks who the booking is for.
prompt_for_adding_more_usersWhether the booking form asks for additional members to add.
prompt_for_number_of_guestsWhether the booking form asks how many guests are attending.
memberships_requiredStripe product ids of the memberships a member must hold to book, or null when the facility is open to everyone.
membership_requirement_modeWhether a member needs any one (or) or all (and) of
memberships_required.
statusWhether the facility is currently bookable or has been archived.
profile_imagesort_orderPosition of the facility in the manually ordered list.
archived_atISO 8601 timestamp of when the facility was archived, or null while it is active.
created_atISO 8601 timestamp of when the facility was created.
updated_atISO 8601 timestamp of when the facility was last changed.
The facility this one sits inside. Included when the parent
relation is requested.
childrenThe sub-facilities inside this one. Included when the children
relation is requested.