Find available start times
find_available_intervalsSearch available start times for a service between two dates, showing free resources and group bookings with space; then use a returned time to create a reservation.
Instructions
Available start times (intervals) for a service between two dates/times, with the resources free at each and any group bookings with space. This is a query sent as POST /availability/intervals/search; it changes nothing. Use one of the returned start times with create_reservation.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | End of the range to search (ISO 8601), after from | |
| from | Yes | Start of the range to search (ISO 8601) | |
| parts | No | Parts of the potential booking (block = booked time, free = gap); when given, duration is ignored. Omit to use the service's own duration or parts | |
| spaces | No | Spaces required (excludes group bookings with fewer spaces left); the API defaults to 1 | |
| buffers | No | Minutes before/after a potential booking that must be free; omit to use the service's buffers | |
| duration | No | Minutes that must be free from the start of an interval; omit to use the service's default duration | |
| timezone | No | IANA timezone to return the results in; the API defaults to Europe/London | |
| service_id | Yes | Service ID (24 hexadecimal characters) | |
| max_results | No | Maximum number of intervals to return | |
| resource_ids | No | Only these resources; omit for every resource assigned to the service | |
| ignore_bookings | No | Booking IDs to ignore for this search (they neither block availability nor count as available group bookings) | |
| resource_group_id | No | Only resources in this resource group (the API's resource_group_ids field, which its spec types as a single string). Not with resource_ids | |
| ignore_group_setting | No | Return group bookings with space even if online group bookings are off | |
| ignore_past_restriction | No | Do not exclude times before now | |
| ignore_service_schedule | No | Ignore the service's schedule | |
| ignore_block_restriction | No | Ignore the organisation's 'block after' setting | |
| ignore_notice_restriction | No | Ignore the organisation's and service's notice-period settings | |
| ignore_service_assignment | No | Do not fail when a resource is not assigned to the service |