Actions32
- Calendar Actions
- Acl Actions
- Event Actions
- Event Attendee Actions
- Event Attendee Chat Member Actions
- Freebusy Actions
- Timeoff Actions
- Setting Actions
- Exchange Binding Actions
Overview
The "Search For Events" operation in the Lark Calendar node allows users to query calendar events within a specified calendar. It supports filtering events based on various criteria such as chat IDs, room IDs, user IDs, and time ranges (start and end times). This operation is useful for retrieving specific events that match certain conditions, enabling automation workflows that need to process or analyze calendar data.
Practical examples include:
- Fetching all events involving particular users or rooms within a given timeframe.
- Searching for events linked to specific chat groups.
- Filtering events by custom queries to find relevant meetings or appointments.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authentication to use: either "Tenant Token" or "OAuth2". |
| Calendar Id | The unique identifier of the calendar from which to search events. Required to specify the target calendar. |
| Filter | A collection of filter criteria to narrow down the search results. Includes: • chat_ids: List of chat group IDs to filter events.• room_ids: List of room IDs.• user_ids: List of user IDs.• start_time and end_time: Objects specifying date, timestamp, and timezone to define the time range. |
| Query | A string query to perform text-based searching within events. |
| Custom Body | JSON object allowing full customization of the request body, overriding other filters and query parameters. Useful for advanced or unsupported filtering scenarios. |
| Options > Use Custom Body | Boolean flag indicating whether to send the custom JSON body instead of the standard filter and query parameters. |
Output
The node outputs JSON data representing the search results of calendar events. Each item in the output typically contains event details matching the search criteria, such as event ID, title, start and end times, participants, and other metadata provided by the Lark Calendar API.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential or OAuth2 token for authenticating with the Lark Suite Open APIs.
- The base URL for API requests is
https://open.larksuite.com/open-apis. - Proper configuration of credentials in n8n is necessary to authorize requests.
Troubleshooting
- Missing or invalid Calendar Id: Ensure the calendar ID is correctly specified; otherwise, the API will not return results.
- Authentication errors: Verify that the selected authentication method is properly configured and the token is valid.
- Incorrect filter format: When using filters, ensure the structure matches expected types (e.g., arrays for IDs, objects for time).
- Using Custom Body: If enabled, the custom JSON must be well-formed and comply with the API schema; malformed JSON will cause request failures.
- Empty results: Check that the filter criteria are not too restrictive or conflicting, which might lead to no events being found.
Links and References
- Lark Suite Calendar API Documentation (for Calendar-related IDs and API details)
- n8n Documentation on HTTP Request Node (for understanding how API calls are made)