Documentation Archive

Developer

CloudKit Web Services Reference

On This Page

Fetching Users by Email (users/lookup/email)

You can fetch discoverable users with their specified email addresses.

Path

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

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.

Request

The POST request is a JSON dictionary containing the following keys:

Key

Description

users

An array of dictionaries, where each dictionary specifies a user and contains a single emailAddress key.

Response

Dictionary containing the results of the operation with the following key:

Key

Description

users

An array of user dictionaries, described in User Dictionary.

Related Framework API

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