iCloud Contacts icon

iCloud Contacts

Fetch all contacts from an iCloud account via CardDAV

Get All

AI-generated

Summary

Fetch all contacts and contact groups from an iCloud account via CardDAV by authenticating with the user's Apple ID credentials.

Inputs

None.

Output shape

a list of JSON objects each representing a contact or contact group, including raw vCard data, a unique UID, and group-related properties if applicable

The output includes all contacts and groups from the user's iCloud address book. Each item contains the full raw vCard text under 'raw', the contact's unique identifier as 'uid', an 'isGroup' boolean indicating if the item is a group, and for groups, 'groupName' and 'memberUids' listing member contact UIDs. Authentication requires HTTP Basic Auth credentials (Apple ID and app-specific password) configured separately. No input parameters are required to fetch all contacts.

Examples

Example 1: Retrieve all contacts from the authenticated iCloud account.

Select the 'Get All' operation without additional parameters; ensure HTTP Basic Auth credentials are set up for the Apple ID.

Links

Discussion