TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

The "Find Many Notes" operation in the Notes resource allows users to retrieve multiple note objects from a data source with flexible querying capabilities. This node is useful when you want to fetch a list of notes filtered, sorted, and paginated according to specific criteria. Common scenarios include displaying notes in a dashboard, exporting notes for reporting, or synchronizing notes with another system.

For example, you could use this node to:

  • Retrieve the most recent 60 notes sorted by creation date.
  • Fetch notes that contain certain keywords or match specific filters.
  • Paginate through notes using cursors to handle large datasets efficiently.

Properties

Name Meaning
Order By Specifies how to sort the returned notes. The value should be a comma-separated list of field names optionally followed by a direction modifier. Directions can be: AscNullsFirst, AscNullsLast, DescNullsFirst, DescNullsLast. If no direction is specified, AscNullsFirst is used by default. Example: createdAt,updatedAtDescNullsLast. Default is sorting by id.
Filter Filters the notes returned based on field comparisons. The filter string supports multiple conditions combined with conjunctions (and, or, not). Comparators include eq, neq, in, containsAny, is, gt, gte, lt, lte, startsWith, like, ilike. You can filter nested fields using dot notation. For example, title[like]:%meeting% or author.name[eq]:John. Defaults to excluding notes with id equal to all zeros UUID.
Limit Limits the maximum number of notes returned in one response. Default is 60.
Depth Controls how much related nested data is included with each note:
- 0: Only the note's own data.
- 1: Note plus directly related objects.
- 2: Note, its related objects, and their related objects.
Default is 1.
Starting After Returns notes starting after a specific cursor value. Useful for pagination. Cursor values are found in the startCursor and endCursor fields of the response's pageInfo.
Ending Before Returns notes ending before a specific cursor value. Also used for pagination. Cursor values come from the response's pageInfo.

Output

The node outputs an array of note objects in the json field of the output data. Each object represents a note with fields as returned by the API, including any nested related objects depending on the Depth parameter.

If pagination is supported, the output may also include metadata such as pageInfo containing cursors (startCursor, endCursor) to facilitate fetching subsequent pages.

This node does not output binary data.

Dependencies

  • Requires an API key credential to authenticate requests to the Twenty API service.
  • The base URL for the API is configured via credentials.
  • The node uses HTTP GET requests with query parameters corresponding to the input properties.

Troubleshooting

  • Empty results: Check your filter syntax and ensure that the filter criteria actually match existing notes.
  • Invalid filter or order_by format: The filter and order_by strings must follow the documented syntax precisely. Errors here will cause the API to reject the request.
  • Pagination issues: When using starting_after or ending_before, ensure you use valid cursor values obtained from previous responses.
  • Authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Rate limiting or network errors: These depend on the external API; consider adding retry logic or handling errors gracefully.

Links and References

Discussion