TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node operation, Find Many Calendar Channel Event Associations, retrieves multiple calendar channel event association records from an external service. It is designed to query and return a list of associations between calendar channels and events, supporting filtering, sorting, pagination, and control over the depth of related nested objects included in the response.

Typical use cases include:

  • Fetching all event associations for a given calendar channel with specific filters (e.g., by date or status).
  • Retrieving a paginated list of event associations sorted by certain fields.
  • Including related nested data up to two levels deep to get comprehensive details about each association and its related entities.

Practical examples:

  • A user wants to display all upcoming event associations for a calendar channel, sorted by start date ascending.
  • An automation workflow needs to process only active event associations filtered by custom criteria.
  • A reporting tool requires detailed information including related objects linked to each event association.

Properties

Name Meaning
Order By Sorts the returned objects by specified fields. Format: field_name_1,field_name_2[DIRECTION_2],.... Directions can be AscNullsFirst, AscNullsLast, DescNullsFirst, DescNullsLast. Default direction is AscNullsFirst. Example: id (default).
Filter Filters the returned objects based on field comparators. Format: field[COMPARATOR]:value,.... Supports comparators like eq, neq, in, containsAny, is, gt, gte, lt, lte, startsWith, like, ilike. Complex filters can use conjunctions or, and, not. Use field[is]:NULL or field[is]:NOT_NULL for null checks. Default filter excludes zero UUID (id[neq]:"00000000-0000-0000-0000-000000000000").
Limit Limits the number of objects returned. Default is 60.
Depth Controls how many levels of nested related objects are included in the response:
- 0: Only primary object.
- 1: Primary object + directly related objects.
- 2: Primary object + directly related objects + their related objects. Default is 1.
Starting After Returns objects starting after a specific cursor value, used for pagination. Cursor values come from startCursor or endCursor in response's pageInfo.
Ending Before Returns objects ending before a specific cursor value, used for pagination. Cursor values come from startCursor or endCursor in response's pageInfo.

Output

The node outputs JSON data containing a list of calendar channel event association objects matching the query parameters. The structure includes:

  • The primary objects representing calendar channel event associations.
  • Nested related objects depending on the depth parameter (up to two levels).
  • Pagination info such as cursors (startCursor, endCursor) within a pageInfo object to support cursor-based pagination.

If binary data were involved, it would typically represent attachments or media related to the events, but this operation focuses on JSON data only.

Dependencies

  • Requires an API key credential or similar authentication token configured in n8n to access the external Twenty API service.
  • The base URL and headers for requests are set from credentials.
  • No additional external dependencies beyond the API service.

Troubleshooting

  • Common issues:

    • Incorrect filter syntax may cause the API to reject the request or return no results.
    • Using invalid cursor values for pagination (starting_after or ending_before) can result in empty responses.
    • Exceeding the limit or requesting too deep nested objects might lead to performance issues or timeouts.

  • Error messages:

    • "Invalid filter format" — Check that the filter string follows the documented comparator and conjunction syntax.
    • "Unauthorized" — Verify that the API key credential is correctly configured and has necessary permissions.
    • "Cursor not found" — Ensure the cursor value used for pagination exists in previous response data.

Links and References

Discussion