Get available appointment slots

Retrieve available booking slots for a specific date, optionally filtered by admin/agent

GET

https://api.channelautomation.com/api/calendar/availability

Query parameters

date
string
required
Date to check availability for (YYYY-MM-DD format)

format: date

workspace_id
string
required
Workspace the calendar belongs to
admin_id
string
required
Admin/agent whose calendar is being queried
event_type_id
optional
string
Restrict to a single event type. Defaults to the workspace's oldest enabled type.

format: uuid
service_appointment_id
optional
string
Required only for workspaces backed by an external availability provider. When present, slots come from the provider instead of the native schedule.

Returns

200

Available slots retrieved successfully

JSON

success
optional
boolean
slots
optional
array of
object
- id
  optional
  string
  Unique identifier for the calendar slot
- start_time
  optional
  string
  Start time of the appointment slot
  
  format: date-time
- end_time
  optional
  string
  End time of the appointment slot
  
  format: date-time
- is_booked
  optional
  boolean
  Whether the slot is already booked
- admin_id
  optional
  string
  ID of the admin/agent assigned to this slot
- title
  optional
  string
  Title/name of the appointment slot
- description
  optional
  string
  Description of what this slot is for
- location
  optional
  string
  Location where the appointment will take place
- booking_type
  optional
  string
  Type of booking allowed
- max_bookings
  optional
  integer
  Maximum number of bookings allowed for this slot
}
date
optional
string
format: date
count
optional
integer

400

Missing required date parameter

JSON

success
optional
boolean
error
optional
string

500

Internal server error

JSON

error
optional
string
details
optional
string
success
optional
boolean

{ "success": true, "slots": [ { "id": "event-uuid-1", "start_time": "2025-07-15T09:00:00Z", "end_time": "2025-07-15T10:00:00Z", "is_booked": false, "admin_id": "admin-uuid", "title": "Consultation Slot", "description": "Available for product consultation", "location": "Virtual Meeting", "booking_type": "single", "max_bookings": 1 } ], "date": "2025-07-15", "count": 5 }