TwentyDEV icon

TwentyDEV

Consume the Twenty API

Actions252

Overview

This node interacts with the Twenty API to retrieve detailed information about a specific workspace member by their unique identifier. It is useful when you need to fetch data about one particular member within a workspace, including optionally related nested objects depending on the depth level specified.

Practical examples include:

  • Retrieving profile details of a team member in a project management workspace.
  • Fetching membership status or roles assigned to a user within a workspace.
  • Accessing related entities such as permissions or linked resources associated with the member.

Properties

Name Meaning
Id The unique identifier (object id) of the workspace member to find. This is required.
Depth Determines how much related nested data to include in the response:
- 0: Only the primary workspace member's information.
- 1: The primary object plus its directly related objects (no further nesting).
- 2: The primary object, its directly related objects, and the related objects of those related ones.

Output

The output JSON contains the detailed information of the requested workspace member. Depending on the Depth parameter, this can include nested related objects up to two levels deep. The structure typically includes fields representing the member’s attributes and any related entities as per the depth setting.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the Twenty API.
  • The base URL for the API is configured via credentials.
  • The node uses standard HTTP headers for JSON content negotiation.

Troubleshooting

  • Missing or invalid Id: If the Id property is empty or incorrect, the API will likely return an error indicating the object was not found. Ensure the correct workspace member ID is provided.
  • Authentication errors: If the API key or domain credentials are missing or invalid, authentication failures will occur. Verify that the API key credential is correctly set up.
  • Depth parameter misuse: Providing an unsupported depth value may cause unexpected results or errors. Use only 0, 1, or 2 as valid options.
  • Network issues: Connectivity problems to the API endpoint will result in request failures. Check network access and API availability.

Links and References

Discussion