TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node interacts with the "People" resource of the Twenty API to find and retrieve detailed information about a single person by their unique identifier. It is useful in scenarios where you need to fetch specific user data, such as profile details or related entities connected to that person.

For example, you might use this node to:

  • Retrieve a user's profile for display in a dashboard.
  • Fetch nested related objects like a person's projects or connections up to a certain depth.
  • Integrate user data into other workflows or systems based on a known user ID.

Properties

Name Meaning
Id The unique identifier (object id) of the person to find. This is required.
Depth Determines how much related nested data to include in the response:
- 0: Only the primary person's information.
- 1: Primary person plus directly related objects.
- 2: Primary person, directly related objects, and their related objects.

Output

The node outputs JSON data representing the found person object. The structure includes the person's main attributes and, depending on the Depth parameter, may also include nested related objects up to two levels deep.

If the node supports binary data output, it would typically represent files or media associated with the person, but based on the provided code and properties, the output focuses on JSON data describing the person and their relations.

Dependencies

  • Requires an API key credential for authenticating requests to the Twenty API.
  • The base URL for the API is configured via credentials.
  • Uses the Twenty API OpenAPI specification internally to build request properties and handle communication.

Troubleshooting

  • Missing or invalid Id: Since the Id property is required, omitting it or providing an incorrect value will likely cause errors or empty responses. Ensure the correct object id is supplied.
  • Invalid Depth value: Only values 0, 1, or 2 are accepted. Providing other values may result in unexpected behavior or errors.
  • Authentication errors: If the API key or domain credentials are missing or incorrect, the node will fail to authenticate. Verify credentials are properly set.
  • Network or API errors: Issues connecting to the Twenty API or server-side problems can cause failures. Check network connectivity and API status.

Links and References

Discussion