TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node operation, Find Many Blocklists, retrieves multiple blocklist objects from an external service via its API. It is useful when you need to query and obtain a list of blocklists with flexible filtering, sorting, pagination, and depth control over related nested data.

Typical use cases include:

  • Fetching all or filtered blocklists for analysis or reporting.
  • Retrieving blocklists sorted by specific fields such as creation date or ID.
  • Paginating through large sets of blocklists using cursors.
  • Controlling the amount of related nested data returned to optimize performance.

For example, you might use this node to get the latest 50 blocklists that do not have a default empty UUID, sorted by their IDs ascending, including related objects one level deep.

Properties

Name Meaning
Order By Sorts the returned blocklists by specified fields. Format: field_name_1,field_name_2[DIRECTION_2],.... Directions can be: AscNullsFirst, AscNullsLast, DescNullsFirst, DescNullsLast. Default direction is AscNullsFirst. Example: id (default).
Filter Filters the blocklists returned based on field comparators. Format: field[COMPARATOR]:value,.... Comparators include eq, neq, in, containsAny, is, gt, gte, lt, lte, startsWith, like, ilike. Supports logical conjunctions or, and, not. Can filter null values with field[is]:NULL or field[is]:NOT_NULL. Default filters out blocklists with empty UUID.
Limit Limits the number of blocklists returned. Default is 60.
Depth Controls how many levels of nested related objects are included in the response:
- 0: Only primary blocklist info.
- 1: Primary blocklist plus directly related objects.
- 2: Primary blocklist, directly related objects, and their related objects. Default is 1.
Starting After Returns blocklists starting after a specific cursor value, used for pagination. Cursor values come from startCursor or endCursor in the response's pageInfo.
Ending Before Returns blocklists ending before a specific cursor value, also for pagination. Cursor values come from startCursor or endCursor in the response's pageInfo.

Output

The node outputs JSON data containing an array of blocklist objects matching the query parameters. Each blocklist object includes its fields and, depending on the Depth parameter, may include nested related objects up to two levels deep.

The output JSON typically contains:

  • The list of blocklists under a key like data or similar.
  • Pagination information such as pageInfo with cursors (startCursor, endCursor) to facilitate paginated requests.
  • Metadata about the total count or other relevant details.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential to authenticate requests to the external Twenty API service.
  • The node uses the base URL configured in the credentials.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Common issues:

    • Invalid filter syntax or unsupported comparator usage may cause API errors.
    • Providing invalid cursor values for pagination (starting_after or ending_before) can result in empty responses or errors.
    • Exceeding the maximum allowed limit may lead to request failures.
    • Incorrect order_by format or unknown fields can cause sorting errors.

  • Error messages:

    • Errors related to authentication usually indicate missing or invalid API credentials.
    • Validation errors on query parameters will specify which parameter is malformed.
    • Network or timeout errors suggest connectivity issues with the external API.

  • Resolutions:

    • Verify filter and order_by strings conform to documented formats.
    • Use cursors exactly as provided in previous responses for pagination.
    • Ensure API credentials are correctly configured and valid.
    • Adjust limits and depth to reasonable values to avoid performance issues.

Links and References

Discussion