Opencell icon

Opencell

Consume Opencell API

Overview

The Generic API - Get Many operation for the Opencell n8n node retrieves a list of entities from the Opencell system using its generic API. This is useful when you want to fetch all records of a particular entity type (such as customers, products, etc.) in bulk. Common scenarios include data synchronization, reporting, or populating dropdowns with available entities.

Practical Example:

  • Fetching all customer records to update an external CRM.
  • Retrieving all product definitions for inventory management.
  • Listing all invoices for reconciliation purposes.

Properties

Name Type Meaning
Authentication options Selects the authentication method: Basic Authentication or OAuth2. Determines which credentials are used for the API connection.
Entity Name or ID options Specifies the entity type to retrieve (e.g., Customer, Product). You can select from a list or provide an entity ID via expression.
Body Content Type hidden Internal property set to "multipart-form-data". Not user-configurable; used for request formatting.

Output

  • The output is a JSON array containing the list of entities retrieved from the Opencell API.
  • Each item in the array represents one entity and includes all fields returned by the Opencell API for that entity type.
  • The structure of each entity object depends on the selected entity but typically includes properties such as code, description, and other relevant fields.

Example Output:

[
  {
    "code": "CUST001",
    "description": "Customer One",
    "...": "..."
  },
  {
    "code": "CUST002",
    "description": "Customer Two",
    "...": "..."
  }
]
  • No binary data is produced by this operation.

Dependencies

  • External Service: Requires access to an Opencell instance with the REST API enabled.
  • Authentication: Needs valid Opencell API credentials (either Basic Auth or OAuth2) configured in n8n.
  • n8n Configuration: Credentials must be set up in n8n under the appropriate credential type (opencellApi for Basic Auth, opencellOAuth2Api for OAuth2).

Troubleshooting

Common Issues:

  • Invalid Credentials: If authentication fails, ensure your credentials are correct and have sufficient permissions.
  • Entity Not Found: If the specified entity does not exist, verify the entity name or ID.
  • API Limits: Large datasets may be paginated or limited by the API (default limit is 250 per request).
  • Network Errors: Ensure the Opencell API endpoint is reachable from your n8n instance.

Error Messages:

  • "Username/password error. Error code : ...": Check your credentials.
  • "Host error. Error code : ...": Verify the Opencell server address and network connectivity.
  • "Invalid credentials (unknown error)": Double-check authentication details.
  • "Unable to get custom fields. Server response: ...": May occur if the entity does not support custom fields.

Links and References

Discussion