Documentation Archive

Developer

CloudKit Web Services Reference

On This Page

Fetching Contacts (users/lookup/contacts)

You can fetch discoverable users in the current user’s address book.

Path

POST [path]/database/[version]/[container]/[environment]/public/users/lookup/contacts

Parameters

path

The URL to the CloudKit web service, which is https://api.apple-cloudkit.com.

version

The protocol version—currently, 1.

container

A unique identifier for the app’s container. The container ID begins with iCloud..

environment

The version of the app’s container. Pass development to use the environment that is not accessible by apps available on the store. Pass production to use the environment that is accessible by development apps and apps available on the store.

Response

The response is a dictionary containing the results of the operation with the following key:

Key

Description

users

An array of user dictionaries, described in User Dictionary, but not including an emailAddress key.

Related Framework API

This request is similar to the CKDiscoverAllContactsOperation class in the CloudKit framework.