Lark Calendar

Lark Calendar Management

Actions32

Calendar Actions
Acl Actions
Event Actions
Event Attendee Actions
Event Attendee Chat Member Actions
- Obtain The List Of Members Of Group Invitees Of An Event
Freebusy Actions
- Query Availability
Timeoff Actions
- Create A Leave Event
- Delete A Leave Event
Setting Actions
- Generate Caldav Configuration
Exchange Binding Actions

Overview

The node "Lark Calendar" provides integration with the Lark Suite calendar service, specifically enabling management and querying of calendar data. The Freebusy - Query Availability operation allows users to check the availability of a user or a room within a specified time range. This is useful for scheduling meetings, avoiding conflicts, and managing shared resources like conference rooms.

Typical use cases include:

Checking if a meeting room is free before booking.
Verifying a user's availability before sending a meeting invite.
Automating calendar checks in workflows that coordinate events or appointments.

Properties

Name	Meaning
Authentication	Method of authentication to use: either "Tenant Token" or "OAuth2".
Room Id	Identifier of the room whose availability is being queried.
Time Max	The upper bound (end) of the time range to check availability, in ISO 8601 datetime format.
Time Min	The lower bound (start) of the time range to check availability, in ISO 8601 datetime format.
User Id	Identifier of the user whose availability is being queried.
Custom Body	A JSON object allowing the user to specify a custom request body instead of using individual parameters. Useful for advanced or non-standard queries.
Options > Use Custom Body	Boolean flag to indicate whether to send the custom JSON body instead of the standard parameters.

Output

The node outputs JSON data representing the availability information returned by the Lark Calendar API's free/busy query endpoint. This typically includes:

Time slots marked as busy or free for the specified user or room.
Details about conflicting events or appointments during the requested time range.

If binary data were involved (not indicated here), it would be summarized accordingly, but this node focuses on JSON calendar data.

Dependencies

Requires access to the Lark Suite Open APIs.
Needs an API authentication token, which can be provided via either:
- A Tenant Token credential.
- An OAuth2 credential.
The base URL for API requests is https://open.larksuite.com/open-apis.
Proper configuration of credentials in n8n is necessary for successful API calls.

Troubleshooting

Authentication errors: Ensure that the selected authentication method is correctly configured and the token is valid and not expired.
Invalid time formats: The time_min and time_max fields must be valid ISO 8601 datetime strings; otherwise, the API may reject the request.
Missing required fields: At least one of user_id or room_id should be provided to query availability meaningfully.
API rate limits: If many requests are made in a short period, the API might throttle requests; consider adding delays or handling retries.
Custom Body usage: When using the custom body option, ensure the JSON structure matches the API expectations exactly to avoid malformed request errors.