Twenty CRMInstall

Summary

Retrieve multiple records from a specified custom object in Twenty CRM, with optional filtering, pagination, and inclusion of related records up to a specified depth.

Inputs

• customObjectApiName (required) — The API name of the custom object to query, which is the plural form used in the API endpoint (e.g., "customLeads", "myCustomObject"). This identifies the target custom object data set.
• returnAll — Whether to return all matching records by automatically handling pagination; applies when retrieving multiple records.
• limit — Maximum number of records to return when not returning all; valid values are 1 to 60.
• customFilters — Optional JSON object representing filters for the query using Twenty CRM's filter syntax (e.g., {"status": {"eq": "active"}}) to refine results.
• customOptions.depth — An integer (0-2) indicating the depth of related records to include in the API response, allowing inclusion of related objects.

Output shape

a list of custom object records

The output contains multiple records from the specified custom object. If filters are used, only matching records are returned. Pagination is handled internally when 'returnAll' is true; otherwise, the number of records is limited by the 'limit' parameter. The response may include nested related records up to the specified 'depth'.

Examples

Example 1: Retrieve up to 20 active records from a custom object 'customLeads' including their first-level relations.

Set 'Object API Name' to 'customLeads', set 'Return All' to false, set 'Limit' to 20, set 'Filters (JSON)' to '{"status": {"eq": "active"}}', and set 'Depth' to 1.

Links

• n8n community nodes installation guide