OmniFlow icon

OmniFlow

Consume OmniFlow API

Actions20

Overview

This node integrates with the OmniFlow API to manage contacts and related entities. Specifically, for the Contact - Get operation, it retrieves detailed information about a single contact by its unique ID. This is useful in scenarios where you need to fetch up-to-date contact details from OmniFlow for further processing, reporting, or synchronization with other systems.

Practical examples include:

  • Fetching a contact's profile before updating their information.
  • Retrieving contact data to personalize communications or marketing campaigns.
  • Using contact details to trigger workflows based on specific attributes.

Properties

Name Meaning
Authentication Method of authentication to use: either "Credentials" (API key) or "OAuth2" token.
Contact ID The unique identifier of the contact to retrieve.
Options Additional options for the request:
  Search (Only for getAll) Filter string or command to search contacts.
  Order By (Only for getAll) Field name to sort the results by.
  Order By Dir (Only for getAll) Sort direction: ASC or DESC.
  Published Only (Only for getAll) Whether to return only currently published contacts.
  Minimal (Only for getAll) Return minimal data without additional nested lists.
  RAW Data If true (default), returns the full raw response including metadata; if false, returns only the main data fields.

For the Get operation on Contact resource, the relevant properties are:

Name Meaning
Authentication Choose between Credentials or OAuth2.
Contact ID The ID of the contact to retrieve.
Options Controls whether to return raw or simplified data.

Output

The output is a JSON array containing one object representing the requested contact. The structure includes all contact fields as returned by the OmniFlow API.

  • If the RAW Data option is enabled (default true), the output contains the full raw response including metadata and nested structures.
  • If RAW Data is disabled (false), the output contains only the core contact data fields without additional nested lists or metadata.

No binary data is produced by this operation.

Example output snippet (simplified):

[
  {
    "id": "contact-id-123",
    "email": "[email protected]",
    "firstname": "John",
    "lastname": "Doe",
    "company": "Example Inc.",
    "phone": "+1234567890",
    ...
  }
]

Dependencies

  • Requires an active OmniFlow API connection configured in n8n.
  • Supports two authentication methods: API key credentials or OAuth2 token.
  • Uses internal helper functions to make HTTP requests to OmniFlow endpoints.

Troubleshooting

  • Invalid Contact ID: If the provided Contact ID does not exist or is malformed, the node will throw an error indicating the contact was not found. Verify the ID is correct.
  • Authentication Errors: Ensure that the selected authentication method is properly configured with valid credentials or tokens.
  • API Rate Limits: If many requests are made in a short time, the OmniFlow API may throttle requests. Implement retry logic or reduce request frequency.
  • Invalid RAW Data Option: Setting RAW Data incorrectly might cause unexpected output formats. Use the default setting unless you require full raw responses.

Links and References

Discussion