Twenty icon

Twenty

Interact with the Twenty API

Actions25

Note → Get

AI-generated

Overview

This node interacts with the Twenty API to retrieve detailed information about a specific note within a Twenty workspace. It is useful for scenarios where you need to fetch and utilize note data programmatically, such as integrating note details into workflows, automating data retrieval for reporting, or syncing note information with other systems.

Use Case Examples

  1. Retrieve a note by its unique identifier to display its content in a dashboard.
  2. Fetch a note along with its directly related records to analyze connections and context.
  3. Automate the extraction of note details for backup or migration purposes.

Properties

Name Meaning
Base URL The base URL for the Twenty workspace REST API, including the /rest suffix.
Note ID The unique identifier of the note to retrieve.
Depth Controls whether related records are expanded in the response. 'Primary Record Only' returns just the note, while 'Include Direct Relations' expands related records.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and request timeout.

Output

JSON

  • id - Unique identifier of the retrieved note.
  • title - Title of the note.
  • content - Content or body of the note.
  • relatedRecords - Expanded related records if depth option is set to include them.
  • createdAt - Timestamp when the note was created.
  • updatedAt - Timestamp when the note was last updated.

Dependencies

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

Troubleshooting

  • Ensure the Note ID is correct and exists in the Twenty workspace to avoid 'not found' errors.
  • Verify the Base URL is correctly set to your Twenty workspace REST API endpoint including the /rest suffix.
  • If using a proxy, confirm the proxy settings and credentials are correct to avoid connection issues.
  • If SSL certificate validation fails, consider enabling 'Ignore SSL Issues' only if you trust the source, as this bypasses security checks.
  • Timeout errors may occur if the server is slow or unresponsive; increase the timeout setting if needed.

Links

Discussion