OmniFlow icon

OmniFlow

Consume OmniFlow API

Actions20

Overview

This node interacts with the OmniFlow API to manage company data. Specifically, for the Company - Get operation, it retrieves detailed information about a single company by its ID. It supports returning either the full raw response or a simplified version containing only the core company fields.

Common scenarios where this node is useful include:

  • Fetching company details to enrich CRM records.
  • Retrieving company information for reporting or analytics.
  • Integrating company data into workflows that require up-to-date company profiles.

Example: You have a workflow triggered by a new lead, and you want to fetch the associated company's details from OmniFlow to personalize follow-up communications.

Properties

Name Meaning
Authentication Method of authentication to use when connecting to OmniFlow API. Options: Credentials, OAuth2
Company ID The unique identifier of the company to retrieve
Simplify Whether to return a simplified version of the response (core fields only) or the full raw data

Output

The output JSON contains the company data retrieved from OmniFlow:

  • If Simplify is true, the output includes only the main company fields under fields.all.
  • If Simplify is false, the output contains the full raw company object as returned by the API.

No binary data is produced by this operation.

Example simplified output structure:

{
  "companyname": "Example Corp",
  "companyemail": "[email protected]",
  "companyphone": "+1234567890",
  "companyindustry": "Technology",
  ...
}

Dependencies

  • Requires an active OmniFlow API credential configured in n8n, either via API key credentials or OAuth2 authentication.
  • The node uses internal helper functions to make HTTP requests to OmniFlow endpoints.
  • No additional external dependencies beyond the OmniFlow API access.

Troubleshooting

  • Invalid Company ID: If the provided company ID does not exist or is malformed, the API will likely return an error. Verify the ID is correct.
  • Authentication Errors: Ensure the API credentials or OAuth2 token are valid and have sufficient permissions.
  • API Rate Limits: Frequent calls may hit rate limits imposed by OmniFlow; consider adding delays or handling retries.
  • Simplify Option Confusion: If expecting full data but getting limited fields, check the "Simplify" property setting.

Common error messages:

  • "error": "Company not found" — Check the company ID.
  • "error": "Unauthorized" — Verify API credentials.
  • "error": "Invalid JSON" — Not applicable here but relevant if using JSON input elsewhere.

Links and References


This summary focuses solely on the Company - Get operation as requested, based on static analysis of the provided source code and properties.

Discussion