Endpoints for event creation, retrieval, and updates
Create Internal Event
Creates a new internal event with the provided details.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
external_system_event_idstring · minLength: 3 · maxLength: 50 · pattern:^[a-zA-Z0-9._-]+$· requiredExternal event ID. Alphanumeric plus ".", "-", and "_" allowed
event_typestring · enum · requiredThe type of event (e.g. "reservation", "maintenance-block"). Always "reservation" for now
Enum values:reservationmaintenance-blocknamestring · minLength: 1 · maxLength: 100 · requiredEvent name
renter_emailstring · email · requiredRenter email
statusstring · enum · requiredEvent status. Always approved for now.
Enum values:approvedactivity_type_idnumber · requiredActivity type ID
timeslotsobject[] · requiredList of event timeslots. At least one timeslot is required.
attendancenumber · min: 0 · max: 500000Attendance. Defaults to 0 if not provided.
Default: 0event_log_messagestring · maxLength: 250Optional log message for event
renter_rate_category_idstring · minLength: 3 · maxLength: 50Renter rate category ID
Responses
Event created successfully
messagestring · requiredResponse message
message_codestring · requiredResponse message code
invocation_idstring · uuid · requiredRequest ID
eventobject · required
Get Event by ID
Retrieves comprehensive details about a specific event identified by its type and ID. Returns all time slots associated with the event, including facility information for each time slot.
path Parameters
event_typestring · enum · requiredThe type of event (e.g. "reservation", "maintenance-block"). Always "reservation" for now
Enum values:reservationmaintenance-blockevent_idstring · minLength: 3 · maxLength: 50 · requiredThe unique identifier of the event. Can be either the Facilitron internal ID (_id) or an external system event ID
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Event retrieved successfully
messagestring · requiredResponse message
message_codestring · requiredResponse message code
invocation_idstring · uuid · requiredRequest ID
eventobject · required
Cancel Internal Event
Cancels an internal event by setting its status to 'cancelled'.
path Parameters
event_typestring · enum · requiredThe type of event (e.g. "reservation", "maintenance-block"). Always "reservation" for now
Enum values:reservationmaintenance-blockevent_idstring · minLength: 3 · maxLength: 50 · requiredThe unique identifier of the event. Can be either the Facilitron internal ID (_id) or an external system event ID
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
statusstring · enum · requiredNew status of the event. Must be "cancelled".
Enum values:cancelled
event_log_messagestring · maxLength: 250Optional log message for event cancellation.
Responses
Event cancelled successfully
messagestring · requiredResponse message
message_codestring · requiredResponse message code
invocation_idstring · uuid · requiredRequest ID
eventobject · required
Change Timeslot of Internal Event
Updates or changes the timeslot of an internal event.
path Parameters
event_typestring · enum · requiredThe type of event (e.g. "reservation", "maintenance-block"). Always "reservation" for now
Enum values:reservationmaintenance-blockevent_idstring · minLength: 3 · maxLength: 50 · requiredThe unique identifier of the event. Can be either the Facilitron internal ID (_id) or an external system event ID
timeslot_idstring · minLength: 3 · maxLength: 50 · pattern:^[a-zA-Z0-9._-]+$· requiredThe unique identifier of the timeslot from the external system. Alphanumeric plus ‘.’, ‘-’, and ‘_’ allowed.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
start_datetimestring · date-time · requiredNew start datetime
end_datetimestring · date-time · requiredNew end datetime
event_log_messagestring · maxLength: 250Optional log message for auditing the change
Responses
Timeslot updated successfully
messagestring · requiredResponse message
message_codestring · requiredResponse message code
invocation_idstring · uuid · requiredRequest ID
timeslotobject · required
Get Events by FacilityId
Retrieves events associated with the specified facility, filtered by date range and event types. Date range cannot exceed 31 days, but if any event falls within the specified range, all of its time slots (up to a year out) will be returned. Events from past dates will not be returned.
path Parameters
facility_idstring · ObjectId · requiredThe unique identifier (_id) of the facility
query Parameters
event_typesstring · requiredEvent type(s) for filtering (e.g. "reservation", "maintenance-block"). For multiple types, provide a comma-separated string.
start_datestring · dateStart date (timezone local to the event) for filtering in ISO 8601 format (YYYY-MM-DD). Cannot be a past date. Defaults to today if not provided.
end_datestring · dateEnd date (timezone local to the event) for filtering in ISO 8601 format (YYYY-MM-DD). Must not exceed 31 days from start_date. Defaults to today if not provided.
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Events retrieved successfully
messagestring · requiredResponse message
message_codestring · requiredResponse message code
invocation_idstring · uuid · requiredRequest ID
eventsobject[] · requiredList of events which include the requested facility
Get Events by PropertyId
Retrieves all events associated with the specified property, filtered by date range and event types. When include_child_events is set to true, the API performs a district-level search, returning events from the specified parent property and all of its child properties. In this case, the date range must not exceed 7 days from today. When include_child_events is false or not provided, only the specified property is queried, and the date range must not exceed 31 days from the start date. If a child property ID is provided, include_child_events does not expand the search — only that property's events will be returned. Events from past dates will not be returned. If any event falls within the specified range, all of its time slots (up to a year out) will be returned.
path Parameters
property_idstring · ObjectId · requiredThe unique identifier (_id) of the property
query Parameters
event_typesstring · requiredEvent type(s) for filtering (e.g. "reservation", "maintenance-block"). For multiple types, provide a comma-separated string.
start_datestring · dateStart date (in the event’s local timezone) for filtering, in ISO 8601 format (YYYY-MM-DD). Cannot be in the past. If
include_child_eventsis set to true, the start and end dates must be the same calendar day, and the search range can extend up to 90 days from today. Defaults to today if not provided.end_datestring · dateEnd date (in the event’s local timezone) for filtering, in ISO 8601 format (YYYY-MM-DD). Cannot be in the past. If
include_child_eventsis set to true, the start and end dates must be the same calendar day, and the search range can extend up to 90 days from today. Ifinclude_child_eventsis false or not provided, the end date must not be more than 31 days after the start_date. Defaults to today if not provided.include_child_eventsbooleanWhen set to true, expands the search across the district — including events from the specified parent property and all of its child properties. Defaults to false. If a child property is specified, the search is limited to that property only.
Default: false
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Events retrieved successfully
messagestring · requiredResponse message
message_codestring · requiredResponse message code
invocation_idstring · uuid · requiredRequest ID
eventsobject[] · requiredList of events which belong to the requested property