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 · requiredHuman-readable event title. Used for display and identification in UI/logs. Length: 1–100 characters.
renter_emailstring · email · requiredRenter email address associated with the event. Used to identify the renter/contact for notifications and reservation context. Format: RFC-compliant email string.
statusstring · enum · requiredEvent status for newly created events. Currently only
approvedis supported for this endpoint.Enum values:approvedactivity_type_idnumber · requiredActivity type identifier used to categorize the event. Must reference a valid activity type configured in the system.
timeslotsobject[] · requiredTimeslots to create under this event. At least one timeslot is required. For multi-timeslot events, provide one item per timeslot in the desired schedule.
attendancenumber · min: 0 · max: 500000Expected attendance headcount for the event. Used for capacity-related workflows and reporting. If omitted, defaults to 0. Range: 0–500,000.
Default: 0renter_ownerstringOptional renter-owner identifier to associate the event with a specific renter owner record. If omitted, the reservation is created as a personal renter (no renter owner association). Provide an existing owner/property identifier to link the renter owner to this event.
event_log_messagestring · maxLength: 250Optional audit note for the event creation request. Stored for traceability and may appear in logs/history. May be omitted or provided as an empty string. Max length: 250.
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 for the specified event, including all associated time slots and their facility information. Each event schema also includes a renter field, which is null by default. To enable renter details in the response, please contact your account manager.
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 date-time for the timeslot in the facility/owner local time. Cannot be older than 7 days in the past. Must be at least 1 minute earlier than
end_datetime. Must be on the same calendar day asend_datetime. Format: ISO 8601 without timezone/offset (e.g.YYYY-MM-DDTHH:mm:ss).end_datetimestring · date-time · requiredNew end date-time for the timeslot in the facility/owner local time. Must be at least 1 minute later than
start_datetime. Must be on the same calendar day asstart_datetime. Cannot be more than 2 years in the future. Format: ISO 8601 without timezone/offset (e.g.YYYY-MM-DDTHH:mm:ss).
activity_namestring | null · maxLength: 250Optional activity name update. If omitted, activity_name is not changed. If provided as null or empty string, activity_name is cleared (set to empty). If provided as a string, activity_name is updated to that value.
facility_u_idstring · maxLength: 50Optional facility UID update. If omitted, facility_u_id is not changed. If provided, current facility_u_id is replaced with the provided valid non-empty facility UID.
event_log_messagestring · maxLength: 250Optional audit note explaining the change. Stored for traceability and may appear in logs/history. May be omitted or provided as an empty string.
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. The date range cannot exceed 31 days, but if any event falls within the specified window, all of its time slots (up to a year out) will be returned. Events from past dates will not be returned. Each event schema also includes a renter field, which is null by default. To enable renter details in the response, please contact your account manager.
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, start_date and end_date must be the same calendar day, and that day cannot be more than 90 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. Each event schema also includes a renter field, which is null by default. To enable renter details in the response, please contact your account manager.
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