TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node operation, Find Many Workspace Members, retrieves a list of workspace members from the Twenty API. It is useful for scenarios where you need to query multiple members within a workspace, such as generating reports on team composition, managing user roles, or syncing member data with other systems.

Practical examples include:

  • Fetching all active members in a workspace to display in a dashboard.
  • Filtering members based on specific criteria like role or status.
  • Paginating through large sets of workspace members using cursors.

Properties

Name Meaning
Order By Sorts the returned workspace members by specified fields and directions. 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 workspace members based on field comparators and values. Format: field[COMPARATOR]:value. Supports complex filters with conjunctions (or, and, not). Comparators include eq, neq, in, containsAny, is, gt, gte, lt, lte, startsWith, like, ilike. Can filter nulls and booleans. Default excludes members with id "00000000-0000-0000-0000-000000000000".
Limit Limits the number of workspace members returned. Default is 60.
Depth Controls how much nested related object data to include: 0 returns only primary objects, 1 includes directly related objects, 2 includes related objects of those related objects. Default is 1.
Starting After Returns workspace members starting after a specific cursor value. Useful for pagination. Cursor values come from startCursor or endCursor in response's pageInfo.
Ending Before Returns workspace members ending before a specific cursor value. Also used for pagination. Cursor values come from startCursor or endCursor in response's pageInfo.

Output

The node outputs JSON data representing a paginated list of workspace members matching the query parameters. The structure typically includes:

  • An array of workspace member objects, each containing member details and optionally nested related objects depending on the depth parameter.
  • Pagination information with cursors (startCursor, endCursor) inside a pageInfo object to facilitate fetching subsequent or previous pages.

If binary data were involved (not indicated here), it would represent file attachments or similar, but this operation focuses on JSON data.

Dependencies

  • Requires an API key credential to authenticate requests against the Twenty API.
  • The base URL for the API is configured via credentials.
  • No additional external dependencies are indicated.

Troubleshooting

  • Empty results: Check your filter syntax and ensure that the filter does not exclude all records (e.g., default filter excludes a zero UUID).
  • Invalid filter or order_by format: Ensure the filter string and order_by string follow the documented formats exactly, including correct comparator names and directions.
  • Pagination issues: Use valid cursor values from previous responses when using starting_after or ending_before.
  • Authentication errors: Verify that the API key credential is correctly set up and has necessary permissions.
  • Depth too high: Requesting a depth level higher than supported may result in incomplete data or errors.

Links and References

Discussion