Twenty icon

Twenty

Interact with the Twenty API

Actions25

Company → List

AI-generated

Overview

This node interacts with the Twenty API to list company records from a Twenty workspace. It allows users to retrieve a list of companies with options to control the number of results, sorting order, filtering criteria, and the depth of related records included in the response. This is useful for scenarios where you need to fetch company data for analysis, reporting, or integration with other systems.

Use Case Examples

  1. Fetch up to 50 companies sorted by name in ascending order.
  2. Retrieve companies filtered by a specific domain name.
  3. Get company records including their direct relations for detailed data.

Properties

Name Meaning
Base URL Base URL for the Twenty workspace REST API, including the /rest suffix.
Limit Maximum number of company records to return, between 1 and 200.
Order By Comma-separated list defining the sort order of the results, e.g., name[AscNullsFirst].
Filter Filter string using Twenty syntax to narrow down the results, e.g., domainName.primaryLinkUrl[eq]:"https://example.com".
Depth Controls whether related records are expanded in the response. 0 for primary record only, 1 to include direct relations.
Starting After Cursor to resume pagination after a given entry.
Ending Before Cursor to request records ending before the given entry.
Request Options Additional request options such as batching, SSL certificate validation, proxy settings, and timeout configuration.

Output

JSON

  • data - Array of company records returned from the API.
  • pagination - Pagination information including cursors for navigating through pages of results.

Dependencies

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

Troubleshooting

  • Ensure the Base URL is correctly set to your Twenty workspace REST API endpoint including the /rest suffix.
  • Verify the API key credential is valid and has necessary permissions.
  • Check filter syntax carefully to avoid errors in query parsing.
  • If SSL errors occur, consider enabling the option to ignore SSL issues, but be aware of security risks.
  • Use pagination cursors (Starting After, Ending Before) correctly to navigate through large result sets.

Discussion