Apaleo Official icon

Apaleo Official

Interact with Apaleo API

Availability → Get Available Services

AI-generated

Summary

Retrieve a list of available services for a specified property within a defined date range, optionally filtering by channel codes, time slice definitions, and template, with support for pagination.

Inputs

  • Group (required) — Select the API resource group, defaulting to 'AvailabilityV1'.
  • PropertyId (required) — The unique identifier of the property for which to fetch available services.
  • From (required) — The start date of the time period to query, inclusive, formatted as a date-time value.
  • To (required) — The end date of the time period to query, inclusive, formatted as a date-time value.
  • Additional Fields — Optional parameters including ChannelCodes to filter by specific channels, PageNumber and PageSize to control pagination, TimeSliceDefinitionIds to filter by specific time slices, and TimeSliceTemplate to specify the time slice template ('DayUse' or 'OverNight').

Output shape

a JSON object representing the retrieved available services for the specified property and date range, potentially paginated according to input parameters

The response includes only items for the requested page. If the page has no items, the API returns HTTP 204 (No Content). The 'From' and 'To' date inputs are converted to ISO date strings (YYYY-MM-DD) before query. Filters and pagination parameters are optional.

Links

Discussion