Opencell

Overview

The Opencell - Generic API: Get operation node retrieves a specific entity from the Opencell system using its name or ID. It allows you to fetch detailed information about an entity, optionally including related nested entities, by specifying their names or IDs. This is useful for integrating Opencell data into your workflows, automating lookups, or enriching other processes with up-to-date entity details.

Common scenarios:

• Fetching customer, product, or other business object details by ID.
• Retrieving an entity and its related/nested objects in one call.
• Using as part of a data synchronization or reporting workflow.

Example:
You want to retrieve all details about a specific "Customer" entity, including its associated "Invoices" and "Subscriptions".

---

Properties

Name	Type	Meaning
Authentication	options	Selects the authentication method for connecting to Opencell (Basic Authentication or OAuth2).
Entity Name or ID	options	Specifies which entity type to retrieve (e.g., Customer, Product). You can select from a list or provide an ID via expression.
ID	number	The unique identifier of the entity to fetch. This is required for the "Get" operation.
Nested Entity Names or IDs	multiOptions	Optionally specify related/nested entities to include in the response. Choose from a list or provide IDs via expression.
Body Content Type	hidden	Internal property; always set to "multipart-form-data". Not user-facing.

---

Output

• The output will be a single JSON object containing the details of the requested entity.
• If nested entities are specified, their data will also be included within the response structure under relevant keys.
• The exact structure depends on the entity type and the nested entities requested, but typically includes all fields available for that entity in Opencell.

Example output:

{
  "id": 123,
  "name": "Sample Customer",
  "status": "ACTIVE",
  "nestedEntity1": { ... },
  "nestedEntity2": [ ... ]
}

---

Dependencies

• External Service: Requires access to an Opencell API instance.
• Authentication: Needs valid credentials for either Basic Authentication or OAuth2, configured in n8n credentials.
• n8n Configuration: No special environment variables needed beyond standard credential setup.

---

Troubleshooting

Common issues:

• Invalid Credentials: If authentication fails, ensure your credentials are correct and have sufficient permissions.
• Entity Not Found: If the provided ID does not exist, the API may return an error or empty result.
• Missing Required Fields: The "ID" field is mandatory; omitting it will cause the node to fail.
• Nested Entities: Specifying invalid nested entity names/IDs may result in errors or missing data in the output.

Error messages:

• "Username/password error. Error code : ..." – Check your authentication settings.
• "Host error. Error code : ..." – Verify the Opencell API endpoint is reachable.
• "Invalid credentials (unknown error)" – Double-check your credentials and network connectivity.

---

Links and References

• Opencell Documentation
• n8n Expressions Guide
• n8n Credentials Setup