Availability API Overview

The Availability API in Slotify provides a comprehensive way to manage and retrieve availability data for resources, schedulers, and events.

This endpoint allows you to define and query availability windows based on the rules set for resources or schedulers to ensure that bookings can only occur during appropriate times.

By leveraging the Availability API, you can dynamically calculate and present available slots to your users and  streamline the scheduling process to prevent booking conflicts.

Key Features of the Availability API

  • Dynamic Availability Calculation: Retrieve availability slots based on current bookings, scheduler rules, and resource constraints to provide real-time visibility into open time slots.
  • Custom Availability Rules: Define availability windows using custom rules, such as specific working hours, buffer times between appointments, and blackout dates to fine-tune when resources or schedulers are available.
  • Timezone Management: Handle availability across multiple time zones to ensure that all availability data is presented in the correct local time, which is crucial for global scheduling operations.
  • Resource and Scheduler Integration: Query availability for specific resources or schedulers to allow for flexible availability management that aligns with your operational needs.
  • Availability Filtering: Use filters to refine availability searches based on parameters such as date ranges, time slots, resource types, and more, to find exactly the slots needed for a specific booking scenario.

Common Use Cases

  • Booking Slot Presentation: Use the Availability API to display available booking slots to customers in real-time, dynamically adjusting based on current bookings and defined availability rules.
  • Preventing Overlaps: Automatically check for available time slots before creating bookings to ensure that no overlaps occur and that resources are correctly allocated.
  • Custom Scheduling Rules: Implement complex scheduling rules, such as alternating availability on certain days, adjusting availability for holidays, or enforcing buffer times between bookings.
  • Multi-Timezone Support: Retrieve availability in the correct timezone for international customers to avoid scheduling errors due to time differences.

Authentication

Before using the Slotify API to manage availability, you must authenticate your requests using App tokens. You can obtain an App token by signing up for a Slotify account and going the app settings page.

All requests to the Slotify API must include an Authorization header with the value "Bearer <AppToken>". App tokens must be Base64 encoded.

Rate Limits

The Availability API is subject to rate limits to ensure fair usage and optimal performance. Please refer to the rate limiting section of the pricing tier for more details on managing your API usage effectively.

Next Steps