GET /users?email={emailAddress}

Purpose

Retrieve user resource given an email address.

Request

Resource URL

GET https://api.ft.com/users?email={emailAddress}

For security reasons requests must be made over HTTPS.

Parameters

Query Param	Value
email	Email address to lookup

Request Headers

Header	Value
Content-Type	application/json
X-Api-Key	<API key value>

Request Body

Not supported.

Response

HTTP Status Codes

Http Status	Description
200 Ok	The lookup by email was executed successfully
400 Bad request	The request was invalid. You may refer to response for details around why the request was invalid
403 Forbidden	Invalid API key used

200 Ok - A lookup by email was executed successfully

Returns a collection (size 0 or 1) of ‘user resources’ that match the email address provided. Zero items (empty collection) indicates that no user was found for that email address. If a user with that email is found, the collection will contain exactly one item. Sample response:

{
    “items”: [
        {
            “id”: “e8e3edde-6e41-414b-b56c-bacb9e9064c8”,
            “href”: “/users/e8e3edde-6e41-414b-b56c-bacb9e9064c8”
        }
    ]
}

400 Bad request - The request was invalid

An Error Resource will be returned with data describing the cause of the error.

403 Forbidden - Your access to the API endpoint was denied

Make sure you are using a valid API key. If you are sure your are using a valid API key and problems persist, contact us for assistance.