Lexware icon

Lexware

Interact with the Lexware API
Join our community

Actions41

Overview

This node integrates with the Lexware API to retrieve multiple contact records ("Contacts" resource, "Get Many" operation). It allows fetching a list of contacts with pagination and filtering options. This is useful for workflows that need to synchronize, analyze, or process contact data from Lexware, such as CRM updates, marketing campaigns, or reporting.

Typical use cases include:

  • Retrieving all contacts in batches or all at once.
  • Filtering contacts by email substring, name substring, customer/vendor roles, or specific customer/vendor numbers.
  • Automating contact data extraction for further processing or integration with other systems.

Properties

Name Meaning
Page Page number of results to fetch (zero-based index).
Size Number of contacts per page (up to 100 or 250 depending on endpoint limits).
Return All Whether to retrieve all pages automatically, ignoring pagination limits (may be subject to API rate limits).
Filter Email String filter (minimum 3 characters) to search within email addresses and contact persons.
Filter Name String filter (minimum 3 characters) to search within contact names (substring match).
Filter Number Numeric filter for customer or vendor number.
Filter Customer Role Option to filter contacts by customer role: Ignore, Has customer role, or Has not customer role.
Filter Vendor Role Option to filter contacts by vendor role: Ignore, Has vendor role, or Has not vendor role.

Output

The node outputs an array of JSON objects representing contacts retrieved from Lexware. Each object contains contact details as provided by the Lexware API, such as names, email addresses, roles, and identifiers.

If binary data were involved (not indicated here), it would typically represent files or attachments related to contacts, but this operation focuses on JSON contact data only.

Dependencies

  • Requires an active connection to the Lexware API via an API key credential configured in n8n.
  • The node depends on the Lexware API's availability and adherence to its rate limits.
  • No additional external dependencies are required beyond the configured API authentication.

Troubleshooting

  • Common issues:

    • Pagination parameters exceeding API limits may cause errors or incomplete data.
    • Filters with fewer than 3 characters for email or name will likely return no results or be ignored.
    • API rate limits might be hit when using "Return All" with large datasets.

  • Error messages:

    • "Unsupported resource": Occurs if the resource parameter is set incorrectly; ensure "contacts" is selected.
    • API authentication errors: Verify that the API key credential is correctly configured and valid.
    • Network or timeout errors: Check network connectivity and Lexware API status.

  • Resolutions:

    • Adjust page size and pagination settings to comply with API limits.
    • Use filters with sufficient length and correct types.
    • Monitor API usage to avoid hitting rate limits.

Links and References

Discussion