sevDesk icon

sevDesk

Consume the sevDesk API
Join our community

Actions98

Overview

This node integrates with the sevDesk API to retrieve multiple communication ways associated with contacts or other entities. Specifically, the "Get Many" operation under the "CommunicationWay" resource fetches a list of communication methods such as emails, phone numbers, web addresses, or mobile numbers. This is useful for scenarios where you need to bulk retrieve contact communication details for marketing campaigns, customer support, or data synchronization.

For example, you might use this node to:

  • Retrieve all email addresses linked to a specific contact.
  • Get the main phone number for multiple contacts.
  • Filter communication ways by type (e.g., only mobile numbers).

Properties

Name Meaning
Filters A collection of filters to narrow down the communication ways returned:
- Contact Filters related to a specific contact:
-- Contact ID The unique identifier of the contact whose communication ways you want to retrieve.
-- Object Name The object name, typically "Contact", required if Contact ID is specified.
- Type The type of communication way to retrieve. Options: Email, Phone, Web, Mobile.
- Main Boolean flag indicating whether to return only the main communication way (true) or all (false).

Output

The node outputs an array of JSON objects representing communication ways matching the specified filters. Each item in the output contains details such as the communication type (email, phone, etc.), the actual contact information (e.g., email address or phone number), and metadata like whether it is marked as the main communication way.

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

Dependencies

  • Requires an API key credential for authenticating with the sevDesk API.
  • The node uses the base URL https://my.sevdesk.de/api/ combined with the API version from credentials.
  • No additional external dependencies beyond the sevDesk API and its authentication.

Troubleshooting

  • Common issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect Contact ID or Object Name may result in empty results.
    • Filtering by a communication type not present for the contact returns no data.
  • Error messages:
    • Errors from the API are caught and returned as JSON with an error field when "Continue On Fail" is enabled.
    • Network or permission errors should be checked by verifying API keys and endpoint accessibility.
  • To resolve errors, ensure correct filter values, valid credentials, and that the sevDesk API service is reachable.

Links and References

Discussion