Twenty icon

Twenty

Interact with the Twenty API

Company → Bulk Match

AI-generated

Overview

This node interacts with the Twenty API to perform bulk matching of company records. It allows users to match multiple company candidates against the Twenty workspace data in a single operation. This is useful for scenarios where you need to verify or enrich company data in bulk, such as during data import, CRM synchronization, or data cleansing processes.

Use Case Examples

  1. Matching a list of companies from an incoming data array to find existing records in Twenty.
  2. Providing a JSON array of company candidates to match against the Twenty database.
  3. Manually building a collection of company records within the node to perform bulk matching.

Properties

Name Meaning
Base URL Base URL for the Twenty workspace REST API, including the /rest suffix.
Match Source Determines the source of company match candidates: built inside the node, from incoming items, or raw JSON input.
Match Entries A collection of company records to match, each with properties like Account Owner ID, Description, Domain URL, Industry, and Name. Used when Match Source is 'Builder'.
Input Property Name Dot notation path to the array on the incoming item that holds the company match candidates. Used when Match Source is 'From Incoming Items'.
Companies (JSON) JSON array describing the company match candidates. Used when Match Source is 'Raw JSON'.
Depth Controls whether related records are expanded in the response: primary record only or including direct relations.
Request Options Additional request settings such as batching (items per batch and interval), SSL certificate validation, proxy settings, and request timeout.

Output

JSON

  • matchedCompanies - Array of matched company records returned from the Twenty API bulk match operation, including expanded related records if requested.

Dependencies

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

Troubleshooting

  • Ensure the Base URL is correctly set with the /rest suffix to avoid connection errors.
  • If using 'From Incoming Items' or 'Raw JSON' match modes, verify the input data structure matches the expected format to prevent parsing errors.
  • Batching settings should be configured carefully to avoid rate limiting or timeouts; adjust batch size and interval as needed.
  • If SSL certificate validation fails, enabling 'Ignore SSL Issues' can bypass this, but use with caution due to security risks.
  • Proxy settings must be correctly formatted if used, including authentication details if required.

Discussion