Actions38
- Bookings Actions
- Customers Actions
- Agents Actions
- Services Actions
- Payments Actions
- Orders Actions
- Coupons Actions
- Locations Actions
- Availability Actions
Agents → Check Availability
AI-generatedSummary
Check agents' availability for a specified date and optionally filter by location, service, start time, and duration.
Inputs
- Location ID — Optional unique identifier of the location to check agents availability for.
- Service ID — Optional unique identifier of the service to check agents availability for.
- Date (required) — The date to check agents availability for in YYYY-MM-DD format.
- Start Time — Optional start time in HH:MM 24-hour format to check agents availability from.
- Duration (minutes) — Duration in minutes for the availability check, defaulting to 60 minutes if unspecified.
- Limit — Maximum number of available agents to return, defaulting to 10.
Output shape
a list of available agents matching the specified criteria, returned as JSON objects in the output.
The operation makes a GET request to the /agents/availability endpoint with query parameters reflecting the input filters. If optional parameters are omitted, they are not included in the request. The response contains agent availability details corresponding to the provided date and filters. No pagination is indicated for this endpoint, but the number of results is limited by the 'Limit' parameter.
Examples
Example 1: Check availability of agents at a specific location and service on a given date for a 2-hour slot starting at 09:00.
Set Location ID, Service ID, Date, Start Time as '09:00', Duration 120 minutes, and Limit 5 to receive up to five available agents.