TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node allows you to retrieve detailed information about a single company from the Twenty API by specifying its unique identifier. It is useful when you need to fetch comprehensive data about a specific company, including optionally nested related objects such as associated teams or projects. For example, you might use this node to display company details in a dashboard or to enrich your CRM records with up-to-date company information.

Properties

Name Meaning
Id The unique identifier of the company object you want to retrieve.
Depth Determines how much related data to include:
- 0: Only the primary company data.
- 1: Company plus directly related objects.
- 2: Company, directly related objects, and their related objects (two levels deep).

Output

The node outputs JSON data representing the requested company object. The structure includes the company's core attributes and, depending on the Depth parameter, nested related objects such as teams, projects, or other linked entities. This hierarchical JSON enables flexible data consumption based on the desired detail level.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating requests to the Twenty API.
  • The node uses the base URL configured in the credentials to send HTTP requests.
  • No additional external dependencies are needed beyond the provided API access.

Troubleshooting

  • Missing or invalid Id: If the Id property is empty or incorrect, the node will fail to find the company. Ensure the ID is valid and corresponds to an existing company.
  • Authentication errors: If the API key credential is missing or invalid, the node will return authentication errors. Verify that the API key is correctly set up in n8n credentials.
  • Depth parameter misuse: Setting an unsupported depth value may cause unexpected results or errors. Use only 0, 1, or 2 as specified.
  • API rate limits or downtime: If the Twenty API is unreachable or rate-limited, the node will throw errors. Check network connectivity and API status.

Links and References

Discussion