TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node operation, Find Many Message Participants, retrieves multiple message participant records from the connected service. It is useful when you want to query and list participants involved in messages, for example, to analyze conversation participants, audit message threads, or integrate participant data into workflows.

Typical use cases include:

  • Fetching all participants of a specific message or set of messages.
  • Filtering participants based on certain criteria (e.g., participant ID, status).
  • Paginating through large sets of participants with cursor-based pagination.
  • Sorting participants by specified fields.

Properties

Name Meaning
Order By Sorts the returned message participants. The value should be a comma-separated list of field names optionally followed by a direction. Directions can be: AscNullsFirst, AscNullsLast, DescNullsFirst, DescNullsLast. Default sorting direction is AscNullsFirst. Example: createdAt,usernameDescNullsLast.
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). For example, id[neq]:"00000000-0000-0000-0000-000000000000" excludes a specific ID. Null and boolean filtering is supported.
Limit Limits the number of participant objects returned in one response. Default is 60. Useful for controlling page size in paginated results.
Depth Controls how much related nested data is included in the response:
- 0: Only primary participant data.
- 1: Participant plus directly related objects.
- 2: Participant, related objects, and their related objects.
This allows tuning response detail level to optimize performance or data needs.
Starting After Cursor-based pagination parameter to return results starting after a specific cursor value. Cursors are found in the response's pageInfo under startCursor or endCursor. Use this to paginate forward through results.
Ending Before Cursor-based pagination parameter to return results ending before a specific cursor value. Also uses cursors from pageInfo. Use this to paginate backward through results.

Output

The node outputs JSON data representing an array of message participant objects matching the query parameters. Each object contains fields describing a participant and may include nested related objects depending on the Depth property.

If binary data were involved (not indicated here), it would be provided separately, but this operation focuses on JSON data only.

The output typically includes pagination metadata such as cursors (startCursor, endCursor) within a pageInfo object to facilitate cursor-based pagination.

Dependencies

  • Requires connection to the Twenty API service with appropriate credentials (an API key or token).
  • The node expects the base URL and authentication headers to be configured via credentials.
  • No additional external dependencies beyond the API service.

Troubleshooting

  • Empty Results: If no participants are returned, verify your filter criteria and ensure that the data exists in the service.
  • Invalid Filter Syntax: Errors may occur if the filter string is malformed. Ensure correct comparator syntax and proper escaping of values.
  • Pagination Issues: Using invalid or expired cursors in starting_after or ending_before will cause errors or empty responses. Always use cursors obtained from previous responses.
  • Permission Errors: Ensure the API credentials have sufficient permissions to read message participant data.
  • Rate Limits: Large requests or frequent calls might hit API rate limits; consider reducing limit or adding delays.

Links and References

Discussion