Actions20
Overview
This node interacts with the OmniFlow API to manage contacts and related entities. Specifically, for the Contact - Get Many operation, it retrieves multiple contact records from OmniFlow based on user-defined filters and options.
Common scenarios where this node is beneficial include:
- Fetching a list of contacts for marketing campaigns or sales outreach.
- Retrieving filtered contacts based on search criteria or sorting preferences.
- Exporting contact data for reporting or integration with other systems.
For example, you might use this node to get all contacts who are currently published and sorted by last name in ascending order, or to retrieve a limited number of contacts matching a specific search term.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authenticating with OmniFlow API: either using Credentials or OAuth2. |
| Return All | Whether to return all matching contacts or limit the number of results. |
| Limit | Maximum number of contacts to return if not returning all (minimum 1). |
| Options | Additional filtering and output options: |
| Search | String or search command to filter contacts by specific criteria. |
| Order By | Column name to sort the results by (any column available in the response). |
| Order By Dir | Sort direction: ascending (ASC) or descending (DESC). |
| Published Only | Whether to return only currently published contacts. |
| Minimal | Whether to return a minimal array of entities without nested lists. |
| RAW Data | If true (default), returns the full raw API response; if false, returns only the main data fields. |
Output
The node outputs an array of contact objects under the json field. Each object represents a contact retrieved from OmniFlow.
- When RAW Data is enabled (default), the output includes the complete raw response data for each contact.
- When RAW Data is disabled, the output contains only the core data fields of each contact, excluding additional nested lists or metadata.
No binary data output is produced by this operation.
Dependencies
- Requires access to the OmniFlow API.
- Requires authentication via either:
- An API key credential.
- OAuth2 token.
- The node uses internal helper functions to make HTTP requests to OmniFlow endpoints.
- No additional external dependencies beyond standard n8n credentials and HTTP request capabilities.
Troubleshooting
- Invalid JSON error: If using JSON parameters for filtering or body content, ensure the JSON syntax is valid. Invalid JSON will cause the node to throw an error.
- API errors: If the OmniFlow API returns errors (e.g., invalid parameters, authentication failure), the node throws an error with details. Check credentials and parameter correctness.
- Limit vs Return All: Setting "Return All" to false but not specifying a valid "Limit" may result in unexpected behavior or errors. Always specify a positive integer limit when not returning all.
- Sorting issues: Ensure the "Order By" value matches a valid column name from the API response; otherwise, sorting may fail or be ignored.
- Filtering with Search: Complex search commands must conform to OmniFlow's expected syntax; incorrect filters may yield no results or errors.
Links and References
- OmniFlow API Documentation (example placeholder, replace with actual URL if known)
- n8n Documentation on Creating Custom Nodes
- General info on OAuth2 Authentication