Actions17
Overview
The "Get Free Slots" operation of the Calendar resource in this node fetches available free time slots from a specified calendar within a given date range. This is useful for scheduling applications, appointment booking systems, or any workflow that requires identifying open times in calendars to avoid conflicts.
Typical use cases include:
- Finding available meeting times across one or multiple users.
- Integrating with scheduling tools to automatically suggest free slots.
- Checking calendar availability before creating new events.
For example, you can specify a calendar ID and a start and end timestamp to retrieve all free slots between those dates, optionally filtering by user IDs or applying additional constraints like timezone or "look busy" status.
Properties
| Name | Meaning |
|---|---|
| Calendar ID | The unique identifier of the calendar to query for free slots. |
| Start Date | The start timestamp (in milliseconds) defining the beginning of the period to check for slots. |
| End Date | The end timestamp (in milliseconds) defining the end of the period to check for slots. |
| Additional Fields | A collection of optional parameters: |
| - Timezone | The timezone to apply when returning the free slots (e.g., America/Chihuahua). |
| - User ID | A single user ID to filter the free slots by a specific user (optional). |
| - User IDs | A comma-separated list of user IDs to filter the free slots by multiple users (optional). |
| - Apply Look Busy | Boolean flag to apply "Look Busy" status to the slots, potentially affecting slot availability. |
Output
The node outputs JSON data representing the free slots retrieved from the calendar service. Each item in the output typically contains details about the available time slots such as start and end times, and possibly associated user information if filtered by user IDs.
If binary data were involved (not indicated here), it would represent attachments or files related to the slots, but this operation focuses on JSON data only.
Dependencies
- Requires an API key credential for authentication with the external HighLevel API service.
- The node makes HTTP requests to
https://services.leadconnectorhq.comwith appropriate headers including versioning. - Proper configuration of OAuth2 credentials or equivalent API authentication is necessary.
- The node depends on the HighLevel API's calendar endpoints to fetch free slots.
Troubleshooting
- Missing or invalid Calendar ID: Ensure the Calendar ID is correctly provided and exists in the connected account.
- Invalid timestamps: Start Date and End Date must be valid Unix timestamps in milliseconds; otherwise, the API may reject the request.
- Authentication errors: Verify that the API key or OAuth token is valid and has permissions to access calendar data.
- Timezone issues: If returned slots appear incorrect, confirm the timezone parameter matches expected values.
- Filtering by User IDs: When using user filters, ensure the user IDs are correct and belong to the calendar context.
- API rate limits or downtime: Temporary failures might occur due to API limits or service outages; retry after some time.
Common error messages will generally relate to invalid parameters, unauthorized access, or network issues. Reviewing the exact API response message helps pinpoint the cause.
Links and References
- HighLevel API Documentation (for detailed API endpoint info)
- Unix Timestamp Converter (to convert human-readable dates to timestamps)
- IANA Time Zone Database (for valid timezone strings)