sevDesk icon

sevDesk

Consume the sevDesk API

Overview

The node integrates with the sevDesk API to retrieve multiple contact records based on specified filters. It is designed to fetch a list of contacts, including organizations and persons, with options to control the depth of returned data and pagination.

This node is useful in scenarios where you need to synchronize or analyze contact data from sevDesk, such as exporting customer lists, generating reports, or integrating contact information into other systems.

Example use cases:

  • Fetching all organizational contacts for marketing campaigns.
  • Retrieving both organizations and their associated persons for CRM synchronization.
  • Paginating through large contact datasets for batch processing.

Properties

Name Meaning
Filters A collection of parameters to filter the contacts returned by the API. Options include:
Depth: Numeric value defining if only organizations (0) or both organizations and persons (1) should be returned.
Customer Number: Filter contacts by a specific customer number.
Customer Name: Filter contacts by name, surname, or family name.
Limit: Maximum number of results to return (minimum 1).
Offset: Number of records to skip for pagination (minimum 1).

Output

The node outputs JSON data representing the list of contacts retrieved from the sevDesk API according to the applied filters. Each item in the output corresponds to a contact record, which may include details about organizations and/or persons depending on the "Depth" filter.

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

Dependencies

  • Requires an active connection to the sevDesk API.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • The base URL for API requests is https://my.sevdesk.de/api/v1/.

Troubleshooting

  • Common issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Using invalid filter values (e.g., negative numbers for limit or offset) may result in API errors.
    • Exceeding API rate limits could lead to temporary request blocking.
  • Error messages:

    • Authentication errors usually indicate invalid or expired API tokens; verify and update credentials.
    • Validation errors on filters suggest checking the input values against allowed ranges and formats.
    • Network or timeout errors require checking connectivity and sevDesk service status.

Links and References

Discussion