Twenty icon

Twenty

Interact with the Twenty API

Note → List

AI-generated

Overview

This node interacts with the Twenty API to list notes from a Twenty workspace. It allows users to retrieve a list of notes with various filtering, sorting, and pagination options. This is useful for workflows that need to process or analyze notes data from Twenty, such as exporting notes, syncing with other systems, or generating reports.

Use Case Examples

  1. Retrieve the latest 50 notes from a Twenty workspace.
  2. List notes filtered by a keyword in the note content.
  3. Fetch notes including related records for deeper context.

Properties

Name Meaning
Base URL Base URL for the Twenty workspace REST API, including the /rest suffix.
Limit Maximum number of note results to return, between 1 and 200.
Order By Comma-separated list to specify the sort order of the results.
Filter Filter string using Twenty syntax to narrow down the notes returned.
Depth Controls whether related records are expanded in the response. Options are Primary Record Only or Include Direct Relations.
Starting After Cursor to resume pagination after a given note entry.
Ending Before Cursor to request records ending before the given note entry.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • notes - Array of note objects returned from the Twenty API.

Dependencies

  • Requires an API key credential for authentication with the Twenty API.

Troubleshooting

  • Ensure the Base URL is correct and includes the /rest suffix to avoid connection errors.
  • Check that the API key credential is valid and has the necessary permissions to access notes.
  • If using filters or order by parameters, verify the syntax matches Twenty API requirements to prevent request failures.
  • Timeout errors may occur if the server is slow; consider increasing the timeout setting.
  • SSL certificate errors can be bypassed by enabling the 'Ignore SSL Issues' option, but this reduces security.

Discussion