CardDAV RESTInstall

Summary

Fetch contacts from a specified address book, optionally filtering by a search string, with control over pagination and result size.

Inputs

• Address Book Name or ID (required) — Select the address book to list contacts from, either by choosing from the loaded options or specifying a name with an expression.
• Return All — Whether to retrieve all contacts by paginating through all results automatically.
• Limit — The maximum number of contacts to return when not returning all; valid values are from 1 to 1000. Defaults to 50.
• Offset — Number of contacts to skip for pagination purposes when not returning all. Defaults to 0.
• Quick Search — Filter contacts by a case-insensitive partial match against name, email, or phone. Leave empty to return all contacts.

Output shape

a list of contact objects from the specified address book, each including the original contact fields plus a _total field indicating the total number of contacts matching the query, and optionally a _warning field if the server provides warnings.

If 'Return All' is true, all contacts matching the optional search are fetched by automatic pagination with page size 1000 until all items are collected. If false, only the specified page limited by 'Limit' and offset by 'Offset' is returned. If no contacts match, the output will include a single item with _total set to zero and possibly _warning if present from the API. Any errors during retrieval cause node execution failure unless 'Continue On Fail' is enabled, in which case the error is returned in the output for the corresponding item.

Examples

Example 1: List up to 50 contacts from the 'Friends' address book starting at the beginning with no filter.

Address Book Name or ID: 'Friends', Return All: false, Limit: 50, Offset: 0, Quick Search: (empty)

Example 2: Retrieve all contacts matching 'john' in the 'Work' address book.

Address Book Name or ID: 'Work', Return All: true, Quick Search: 'john'

Links

• n8n community nodes installation guide