sevDesk icon

sevDesk

Consume the sevDesk API

Overview

This node integrates with the sevDesk API to perform various operations on sevDesk resources. Specifically, for the Contact resource and the Find By Custom Field Value operation, it allows users to search for contacts based on a custom field's value. This is useful when you want to filter or locate contacts that have specific data stored in custom fields, such as tags, identifiers, or other metadata not covered by standard contact properties.

Practical examples include:

  • Finding all contacts where a custom field "Customer Type" equals "VIP".
  • Searching contacts by a unique external ID stored in a custom field.
  • Filtering contacts based on any user-defined attribute stored in sevDesk custom fields.

Properties

Name Meaning
Custom Field Setting A collection specifying which custom field to check. It includes:
- Custom Field Setting ID The ID of the custom field setting to be checked (identifies the specific custom field).
- Object Name The object name related to the custom field setting; usually "ContactCustomFieldSetting".
Value The string value to match against the specified custom field. Contacts with this value will be found.

Output

The node outputs an array of JSON objects representing the contacts that match the given custom field value. Each item in the output corresponds to one matching contact record retrieved from sevDesk.

If an error occurs during execution and "Continue On Fail" is enabled, the output will include an error object with the error message for the respective input item.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the sevDesk API via an API key credential.
  • The node uses the base URL https://my.sevdesk.de/api/ combined with the API version specified in credentials.
  • Environment configuration validation is performed before execution.
  • The node depends on internal resource management and validation schema modules bundled within the node implementation.

Troubleshooting

  • Common issues:

    • Incorrect or missing Custom Field Setting ID may result in no matches or errors.
    • Providing a value that does not exist in the specified custom field will return an empty result set.
    • Network or authentication failures with the sevDesk API can cause request errors.
  • Error messages:

    • Errors returned from the API are captured and can be output if "Continue On Fail" is enabled.
    • Validation errors may occur if required parameters are missing or malformed.
  • Resolutions:

    • Verify the Custom Field Setting ID is correct and corresponds to an existing custom field in sevDesk.
    • Ensure the API key credential is valid and has sufficient permissions.
    • Check network connectivity and sevDesk service status.

Links and References

Discussion