sevDesk icon

sevDesk

Consume the sevDesk API
Join our community

Actions98

Overview

This node integrates with the sevDesk API to retrieve multiple contact records based on specified filters. It is useful for scenarios where you need to fetch a list of contacts (organizations and/or persons) from your sevDesk account, optionally filtered by various criteria such as category, location, creation or update dates, tags, and more.

Practical examples include:

  • Exporting all contacts created after a certain date.
  • Retrieving contacts filtered by city or country.
  • Getting contacts ordered by customer number.
  • Fetching both organizations and their associated persons in one request.

Properties

Name Meaning
Filters A collection of optional filters to narrow down the contacts returned. The available filters are:
  Category Filter contacts by category using an ID and object name ("Category").
  City Filter contacts by city name (string).
  Country Filter contacts by country using an ID and object name ("StaticCountry").
  Create After Return contacts created after this date/time.
  Create Before Return contacts created before this date/time.
  Customer Number Filter contacts by customer number (string).
  Depth Defines whether to return only organizations (0) or both organizations and persons (1).
  Name Filter contacts by name (string).
  Order By Customer Number Sort contacts by customer number in ascending (ASC) or descending (DESC) order.
  Parent Filter contacts by parent contact using an ID and object name ("Contact").
  Tags Filter contacts by tags using an ID and object name ("Tag").
  Update After Return contacts updated after this date/time.
  Update Before Return contacts updated before this date/time.
  Zip Filter contacts by ZIP code (string).

Output

The node outputs an array of JSON objects representing the contacts retrieved from sevDesk. Each item corresponds to a contact record matching the applied filters. The exact structure of each contact object depends on the sevDesk API response but typically includes fields like contact ID, name, category, address details, tags, and other relevant contact information.

No binary data output is produced by this operation.

Dependencies

  • Requires an active sevDesk API key credential configured in n8n.
  • The node uses the sevDesk API base URL with versioning, which is set via credentials.
  • Environment configuration validation is performed at runtime to ensure proper setup.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect filter values (e.g., invalid IDs or date formats) may result in empty responses or errors.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • Errors thrown by the node include the message from the underlying API or network error.
    • If "Continue On Fail" is enabled, errors for individual items are returned as JSON with an error field describing the issue.

  • Resolution tips:

    • Verify that the API key credential is correctly configured and has necessary permissions.
    • Double-check filter inputs for correct types and valid values.
    • Ensure the environment variables and configurations required by the node are properly set.

Links and References

Discussion