Retrieves availability information for all properties and room types for a given date range. Use when you need to check availability across all properties in the account. Returns empty array if no availability data exists for the specified period.
periodEndRequiredstringThe end date of the period to check availability (REQUIRED). Format: YYYY-MM-DD.
periodStartRequiredstringThe start date of the period to check availability (REQUIRED). Format: YYYY-MM-DD.
BookingsOnlybooleanIndicates whether to retrieve only booking information, excluding other availability details. This option is only valid for room type queries.
ModifiedSincestringFilters the results to include only sub-periods modified after the specified date, up to 6 months prior to the current date. Format: YYYY-MM-DD. This option is only valid for room type queries.
CombineRoomTypesbooleanIndicates whether to combine results from different room types into a single house total.
IncludeBookingIdsbooleanIndicates whether to include the list of booking identifiers in the response. This option is only valid for room type queries.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action
No published Skills explicitly reference this Action yet.