TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node operation, Find Many Workflows, retrieves multiple workflow objects from an external service via its API. It is designed to query and return a list of workflows with flexible filtering, sorting, pagination, and depth control on related nested data.

Typical use cases include:

  • Fetching a list of workflows for display or further processing.
  • Querying workflows based on specific criteria such as ID, status, or other fields.
  • Paginating through large sets of workflows using cursors.
  • Controlling the amount of related data included in the response to optimize performance.

For example, you might use this node to get all active workflows sorted by creation date, or to retrieve workflows that match certain tags or properties.

Properties

Name Meaning
Order By Sorts the returned workflows by specified fields. Format: field_name_1,field_name_2[DIRECTION_2],.... Directions can be AscNullsFirst, AscNullsLast, DescNullsFirst, DescNullsLast. Default direction is AscNullsFirst. Example: createdAt,updatedAtDescNullsLast sorts by creation date ascending and update date descending.
Filter Filters workflows based on field comparators and values. Format: field[COMPARATOR]:value. Supports complex filters with conjunctions (or, and, not). Comparators include eq, neq, in, containsAny, is, gt, gte, lt, lte, startsWith, like, ilike. Can filter nulls and booleans. Example: status[eq]:active or id[neq]:"0000...".
Limit Limits the number of workflows returned in one request. Default is 60.
Depth Controls how many levels of nested related objects are included in the response:
- 0: Only primary workflow data.
- 1: Primary workflow plus directly related objects.
- 2: Primary workflow, directly related objects, and their related objects.
Starting After Returns workflows starting after a specific cursor value, used for pagination. Cursor values come from startCursor or endCursor in the response's pageInfo.
Ending Before Returns workflows 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 workflow objects matching the query parameters. Each workflow object includes its fields and, depending on the depth parameter, nested related objects up to two levels deep.

The output structure typically includes:

  • An array of workflows under a key like data or similar.
  • Pagination information such as pageInfo with cursors (startCursor, endCursor) to support paginated requests.
  • Metadata about total counts or limits may also be present depending on the API.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential to authenticate requests to the external service hosting the workflows.
  • The node uses HTTP requests with JSON payloads and expects the API base URL and authentication token configured in credentials.
  • No additional environment variables or external services beyond the authenticated API endpoint are required.

Troubleshooting

  • Empty results: Check your filter syntax and values; ensure the filter matches existing workflows.
  • Invalid filter or order_by format: The API expects specific formats for these strings. Refer to the property descriptions for correct syntax.
  • Pagination issues: Use the cursors provided in the response's pageInfo correctly for starting_after and ending_before.
  • Authentication errors: Ensure the API key credential is valid and has sufficient permissions.
  • Depth too high: Requesting too deep nested data may cause performance issues or API errors if unsupported.

Links and References

Note: Replace placeholder links with actual documentation URLs when available.

Discussion