TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node allows you to retrieve a single "View Sort" object by its unique identifier from the Twenty API. It is useful when you need detailed information about a specific view sort configuration, such as in dashboards or data views where sorting criteria are applied. For example, you might use this node to fetch the sorting details of a particular report or user interface element to display or modify it programmatically.

Properties

Name Meaning
Id The unique identifier of the View Sort object you want to retrieve. This is required.
Depth Controls how much related nested data is included in the response:
- 0: Only the primary View Sort object information.
- 1: The primary object plus its directly related objects (no further nesting).
- 2: The primary object, its directly related objects, and their related objects (two levels deep).

Output

The node outputs a JSON object representing the requested View Sort. Depending on the Depth parameter, this JSON may include nested related objects up to two levels deep. The structure typically contains all properties of the View Sort, such as sorting fields, directions, and any associated metadata. There is no binary output for this node.

Dependencies

  • Requires an API key credential to authenticate with the Twenty API.
  • The base URL for the API is configured via credentials.
  • The node uses standard HTTP headers for JSON communication (Accept: application/json, Content-Type: application/json).

Troubleshooting

  • Missing or invalid Id: If the Id property is empty or incorrect, the API will likely return an error indicating that the object was not found. Ensure the Id is correct and corresponds to an existing View Sort.
  • Authentication errors: If the API key or domain credentials are missing or invalid, authentication will fail. Verify that the credentials are properly set up in n8n.
  • Depth parameter misuse: Providing an unsupported depth value could cause unexpected results or errors. Use only 0, 1, or 2 as specified.
  • Network issues: Connectivity problems with the API endpoint can cause request failures. Check network access and API availability.

Links and References

Discussion