Twenty icon

Twenty

Interact with the Twenty API

Actions25

Person → Get

AI-generated

Overview

This node interacts with the Twenty API to retrieve detailed information about a specific person within a Twenty workspace. It is useful for scenarios where you need to fetch a person's data by their unique identifier, optionally including related records to a specified depth. For example, it can be used in workflows that require accessing employee or contact details stored in Twenty for further processing or integration with other systems.

Use Case Examples

  1. Retrieve a person's primary record by their ID to display or use in another system.
  2. Fetch a person's record along with their direct relations to understand their connections within the organization.

Properties

Name Meaning
Base URL The base URL for the Twenty workspace REST API, including the /rest suffix.
Person ID The unique identifier of the person to retrieve.
Depth Controls whether related records are expanded in the response, with options for primary record only or including direct relations.
Request Options Additional request settings such as batching, SSL certificate validation, proxy configuration, and request timeout.

Output

JSON

  • id - Unique identifier of the retrieved person.
  • name - Name of the person.
  • email - Email address of the person.
  • relatedRecords - Optional related records included based on the depth parameter.

Dependencies

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

Troubleshooting

  • Ensure the Person ID is correct and exists in the Twenty workspace to avoid 'not found' errors.
  • Check the Base URL is correctly set to your Twenty workspace REST API endpoint including the /rest suffix.
  • If SSL errors occur, consider enabling 'Ignore SSL Issues' only if you trust the network environment.
  • Proxy settings must be correctly configured if your network requires a proxy for outbound HTTP requests.
  • Timeout settings should be adjusted if the server response is slow to prevent premature request abortion.

Discussion