TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node operation, Find Many Calendar Events, retrieves multiple calendar event records from an external calendar service. It is designed to query and return a list of events based on various filtering, sorting, and pagination criteria.

Typical use cases include:

  • Fetching upcoming or past calendar events for display or processing.
  • Synchronizing calendar events with other systems.
  • Filtering events by specific attributes such as date ranges, status, or custom fields.
  • Paginating through large sets of calendar events efficiently.

For example, you could use this node to get the next 60 upcoming events ordered by start time, or to find all events that match certain criteria like containing a keyword in their title.

Properties

Name Meaning
Order By Specifies how to sort the returned calendar events. The value should be a comma-separated list of field names optionally followed by a direction modifier. Directions can be: AscNullsFirst, AscNullsLast, DescNullsFirst, DescNullsLast. If no direction is specified, AscNullsFirst is used by default. Example: start_time,created_atDescNullsLast. Default is id.
Filter Filters the calendar events returned. The filter string supports complex expressions using field comparators such as eq (equals), neq (not equals), in, containsAny, is (for null checks), gt (greater than), gte, lt, lte, startsWith, like, ilike. Logical conjunctions like and, or, not are supported. For example: status[eq]:confirmed,and,start_time[gte]:2023-01-01. Defaults to exclude events with id equal to all zeros UUID.
Limit Limits the number of calendar events returned in one response. Default is 60.
Depth Controls how much related nested data is included with each calendar event:
- 0: Only primary event data.
- 1: Event plus directly related objects.
- 2: Event, directly related objects, and their related objects.
Default is 1.
Starting After Cursor-based pagination parameter to return events starting after a specific cursor value. Useful for paginating forward through results. Cursors are found in the response's pageInfo object.
Ending Before Cursor-based pagination parameter to return events ending before a specific cursor value. Useful for paginating backward through results. Cursors are found in the response's pageInfo object.

Output

The node outputs JSON data representing a collection of calendar event objects matching the query parameters. Each event object includes its properties and, depending on the Depth setting, may include nested related objects such as attendees, locations, or linked resources.

The output structure typically includes:

  • An array of calendar event objects under a key like data or similar.
  • Pagination information such as cursors (startCursor, endCursor) and page info to support further paging.
  • Metadata about the total count or limits applied.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the external calendar service.
  • The node uses HTTP requests to communicate with the calendar API endpoint configured via credentials.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Empty results: Check your filter criteria; overly restrictive filters or incorrect field names can result in no events returned.
  • Invalid filter syntax: Ensure the filter string follows the documented format with correct comparator usage and logical conjunctions.
  • Pagination issues: Use the cursors provided in the response's pageInfo correctly for starting_after and ending_before parameters to paginate.
  • Authentication errors: Verify that the API key or token credential is valid and has sufficient permissions.
  • Sorting errors: Confirm that the order_by field names exist and directions are spelled correctly.

Links and References

Discussion