TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node operation "Find Many Views" retrieves multiple view objects from the connected service, allowing users to query and paginate through a collection of views. It is useful in scenarios where you want to list or analyze multiple views with specific filtering, sorting, and pagination controls.

Practical examples include:

  • Fetching all views created after a certain date.
  • Retrieving views sorted by creation time or name.
  • Paginating through large sets of views for reporting or synchronization purposes.
  • Filtering views based on specific criteria such as status or associated user.

Properties

Name Meaning
Order By Sorts the returned views by specified fields. Format: field_name_1,field_name_2[DIRECTION_2],.... Directions can be AscNullsFirst, AscNullsLast, DescNullsFirst, DescNullsLast. Default direction is AscNullsFirst. Example: createdAt,updatedAtDescNullsLast sorts by creation date ascending and update date descending with nulls last.
Filter Filters the views returned using field comparators. Format: field[COMPARATOR]:value. Comparators include eq, neq, in, containsAny, is, gt, gte, lt, lte, startsWith, like, ilike. Supports logical conjunctions or, and, not. Can filter null values with field[is]:NULL or boolean values with field[eq]:true/false. Example: status[eq]:active.
Limit Limits the number of views returned in one response. Default is 60. Useful for controlling page size when paginating through results.
Depth Controls how deeply nested related objects are included in the response: 0 returns only primary view data, 1 includes directly related objects, 2 includes related objects of those related objects. This helps control response size and detail level.
Starting After Returns views starting after a specific cursor value, used for cursor-based pagination. Cursor values come from startCursor or endCursor in the response's pageInfo.
Ending Before Returns views ending before a specific cursor value, also used for cursor-based pagination. Cursor values come from startCursor or endCursor in the response's pageInfo.

Output

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

  • A list/array of view objects with their properties and optionally nested related objects depending on the depth parameter.
  • Pagination information under a pageInfo object, including cursors (startCursor, endCursor) to facilitate pagination with starting_after and ending_before.
  • Metadata about total counts or limits may also be present depending on the API response.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Twenty API service.
  • The base URL and authentication headers are configured via node credentials.
  • No additional external dependencies beyond the API service.

Troubleshooting

  • Empty Results: If no views are returned, verify that your filter criteria are correct and that there are views matching those filters.
  • Invalid Filter Syntax: Errors may occur if the filter string is malformed or uses unsupported comparators. Ensure the filter follows the documented syntax.
  • Pagination Issues: Using invalid or expired cursor values in starting_after or ending_before may cause errors or empty responses. Use cursors directly from the previous response's pageInfo.
  • Authentication Errors: Ensure the API key credential is valid and has necessary permissions.
  • Depth Parameter Misuse: Setting depth too high may result in large payloads and slow responses; adjust according to needs.

Links and References

This summary is based solely on static analysis of the provided source code and property definitions.

Discussion