TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node operation, Find Many Calendar Event Participants, retrieves multiple participant records associated with calendar events. It is useful when you want to list or query participants for one or more calendar events, applying filters, sorting, and pagination to manage large datasets efficiently.

Typical use cases include:

  • Fetching all participants of a specific calendar event or set of events.
  • Filtering participants based on attributes such as ID, status, or other participant-related fields.
  • Sorting participants by various fields in ascending or descending order.
  • Paginating through participant lists using cursors.
  • Controlling the depth of related nested data returned (e.g., including related user or event details).

Properties

Name Meaning
Order By Sorts the returned participant objects. Accepts a comma-separated list of field names optionally followed by a direction modifier. Directions can be: AscNullsFirst, AscNullsLast, DescNullsFirst, DescNullsLast. Default direction is AscNullsFirst. Example: id,createdAtDescNullsLast
Filter Filters the returned participants using conditions on fields. Supports comparators like eq, neq, in, containsAny, is, gt, gte, lt, lte, startsWith, like, ilike. Complex filters can be built using conjunctions (or, and, not). Null filtering and boolean filtering are supported. Example: id[neq]:"00000000-0000-0000-0000-000000000000"
Limit Limits the number of participant objects returned in the response. Default is 60.
Depth Controls how much nested related data is included: 0 returns only primary participant info; 1 includes directly related objects; 2 includes related objects of those related objects. Useful to control response size and detail level.
Starting After Returns participants starting after a specific cursor value, used for pagination. Cursor values come from startCursor or endCursor in the response's pageInfo.
Ending Before Returns participants ending before a specific cursor value, also for pagination. Cursor values come from startCursor or endCursor in the response's pageInfo.

Output

The node outputs JSON data containing an array of calendar event participant objects matching the query parameters. The structure typically includes:

  • Participant fields such as IDs, names, statuses, and any other participant-specific data.
  • Nested related objects depending on the depth parameter, e.g., linked user profiles or event details.
  • Pagination information under pageInfo, including cursors (startCursor, endCursor) to facilitate fetching subsequent or previous pages.

If binary data were involved (not indicated here), it would represent files or attachments related to participants, but this operation focuses on JSON data.

Dependencies

  • Requires an API key credential to authenticate requests against the Twenty API service.
  • The base URL for API calls is configured dynamically from credentials.
  • No additional external dependencies beyond the Twenty API and its authentication.

Troubleshooting

  • Empty results: Check your filter criteria; overly restrictive filters may return no participants.
  • Invalid filter syntax: Ensure filters follow the specified format with correct comparators and conjunctions.
  • Pagination issues: Use valid cursor values from previous responses for starting_after and ending_before.
  • API authentication errors: Verify that the API key credential is correctly configured and has necessary permissions.
  • Depth too high: Requesting very deep nested data may increase response time or cause timeouts; try reducing the depth parameter.

Links and References

Discussion