CardDAV icon

CardDAV

Interact with CardDAV servers for address book operations
Join our community

Actions5

Overview

The node interacts with CardDAV servers to perform address book operations. Specifically, the Get Contacts operation retrieves contacts from a specified address book path on a CardDAV server. It supports filtering contacts by all entries, by name, or by email, allowing users to search for specific contacts efficiently.

This node is beneficial in scenarios where you need to integrate contact data from CardDAV-compatible address books into workflows, such as syncing contacts, automating communication tasks, or managing contact lists dynamically.

Example use cases:

  • Fetching all contacts from a user's address book to update a CRM system.
  • Searching for contacts by name or email to trigger personalized email campaigns.
  • Integrating with other systems that require up-to-date contact information stored on a CardDAV server.

Properties

Name Meaning
Address Book Path The server-relative path to the specific address book (e.g., /addressbooks/user/contacts/). Must start with "/". Spaces and special characters are automatically URL-encoded.
Filter Filter type for retrieving contacts. Options: All Contacts, By Name, By Email.
Search Term The term used to filter contacts when filtering by name or email. Example: "John Doe".

Output

The output JSON contains:

  • contacts: An array of contact objects, each including:

    • href: The relative URL path to the contact resource.
    • etag: The entity tag for the contact, useful for caching or concurrency control.
    • addressData: The raw vCard data of the contact, decoded and formatted with proper line endings.

  • statusCode: The HTTP status code returned by the CardDAV server for the request.

No binary data output is produced by this operation.

Dependencies

  • Requires connection to a CardDAV server with valid credentials including a base URL starting with http:// or https://.
  • The node expects an API key or authentication token configured in n8n credentials to authorize requests to the CardDAV server.
  • The CardDAV server must support XML-based PROPFIND and REPORT methods as per the CardDAV protocol.

Troubleshooting

  • Invalid Base URL in credentials: Ensure the base URL includes the protocol (http:// or https://) and does not end with a trailing slash.
  • Absolute URLs not allowed in path fields: Use server-relative paths starting with / for address book paths; do not provide full URLs.
  • Host not found / Connection refused / Timeout errors: Verify network connectivity, server hostname, port accessibility, and firewall settings.
  • HTTP errors (4xx or 5xx): Check permissions, address book path correctness, and server availability.
  • Empty or no contacts returned: Confirm the address book path is correct and that contacts exist matching the filter criteria.

Links and References

Discussion