REST API for Latepoint icon

REST API for Latepoint

Consume REST API for LatePoint on Tools
Join our community

Actions40

Overview

The "Check Availability" operation under the "Agents" resource allows users to query which agents are available for booking at a specified location, service, date, and time. This node is useful in scheduling and booking workflows where you need to find available staff or agents before creating appointments or reservations.

Typical use cases include:

  • Finding available agents for a particular service on a given date and time.
  • Limiting the number of returned available agents to optimize selection.
  • Filtering availability by location and service to narrow down suitable agents.

For example, a business could use this node to check which customer support agents are free to handle calls on a specific day or which technicians are available for a service appointment at a certain branch.

Properties

Name Meaning
Description A text prompt describing the purpose or context of the API call to help AI understand the request.
Location ID (Optional) The unique identifier of the location to check agent availability for.
Service ID (Optional) The unique identifier of the service to check agent availability for.
Date The date to check agent availability for, in YYYY-MM-DD format.
Start Time (Optional) The start time to check availability, in HH:MM 24-hour format.
Duration (minutes) (Optional) The length of time in minutes to check availability for; defaults to 60 minutes if omitted.
Limit (Optional) Maximum number of available agents to return; defaults to 10 if not specified.

Output

The output JSON contains an array of available agents matching the criteria. Each item represents an agent with their details as returned by the LatePoint API's /agents/availability endpoint.

The structure typically includes agent identifiers, names, and availability slots corresponding to the requested date, time, and duration.

No binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the LatePoint REST API.
  • The base URL and API key must be configured in the node credentials.
  • The node sends HTTP GET requests to the LatePoint API endpoints.

Troubleshooting

  • Missing Credentials: If no API key is configured, the node will throw an error "No credentials configured!" Ensure that the required API authentication token is set up properly.
  • Invalid Date or Time Format: The date must be in YYYY-MM-DD format and startTime in HH:MM 24-hour format. Incorrect formats may cause API errors or empty results.
  • Empty Results: If no agents are returned, verify that the location ID, service ID, date, and time parameters correspond to actual available agents in the system.
  • Limit Exceeded: The limit property accepts values between 1 and 100. Values outside this range may cause errors or be ignored.
  • API Errors: Network issues or invalid API keys will result in errors. Check connectivity and credential validity.

Links and References

Discussion