Twenty icon

Twenty

Interact with the Twenty API

Company → Get

AI-generated

Overview

This node interacts with the Twenty API to retrieve detailed information about a specific company within a Twenty workspace. It is useful for scenarios where you need to fetch company data by its unique identifier, optionally including related records to a specified depth. For example, it can be used in workflows that require company details for CRM updates, reporting, or integration with other systems.

Use Case Examples

  1. Retrieve a company's primary record by its ID to display basic company information.
  2. Fetch a company along with its direct relations to get a more comprehensive view of the company's connections.

Properties

Name Meaning
Base URL The base URL for the Twenty workspace REST API, including the /rest suffix.
Company ID The unique identifier of the company 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 company.
  • name - Name of the company.
  • details - Additional details about the company, including expanded related records if depth option is set.

Dependencies

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

Troubleshooting

  • Ensure the Company ID is correct and exists in the Twenty workspace to avoid 'not found' errors.
  • Check the Base URL is correctly set to the workspace's REST API endpoint including the /rest suffix.
  • If SSL errors occur, consider enabling the 'Ignore SSL Issues' option, but be aware of security risks.
  • Proxy settings must be correctly configured if used, including authentication if required.
  • Timeout settings should be adjusted based on network conditions to prevent premature request abortion.

Discussion