Optima REST APIInstall

Summary

Retrieve multiple customer records from the Comarch Optima ERP system, optionally filtering, paginating, and controlling output format.

Inputs

• id — Optional specific customer ID to retrieve.
• filter — Optional SQL-like filter string to search customers, e.g. "Knt_Kod = 'ACME'" or "Knt_Nip = '1234567890'".
• skip — Optional number of records to skip for pagination; defaults to 0.
• take — Optional maximum number of customer records to return for pagination; defaults to 100.
• outputMode — Optional mode to control the output format: 'split' returns each customer as a separate item; 'array' returns all customers in a single item as an array. Defaults to 'split'.

Output shape

list of customer records or a single item containing an array of customers

If 'outputMode' is 'split', the node returns each customer as a separate JSON item; if no customers are found, it returns a single item with metadata indicating zero results. If 'outputMode' is 'array', the node returns all matching customers inside a single JSON item array. Binary data from input is preserved on the first output item if present.

Examples

Example 1: Get multiple customers matching a filter

Set a SQL-like filter expression, e.g., "Knt_Kod = 'TEST'", and adjust 'skip' and 'take' for pagination if needed. Choose 'outputMode' based on how you want results emitted.

Example 2: Retrieve a specific customer by ID

Set the 'id' option to the customer ID to fetch just that one customer record.

Links

• n8n community nodes installation guide