GET /v1/user/by_email

NOTE: This method is not accessible to users on Starter Plan API keys. Please contact us if you want premium access to our service.

HTTP Method: GET

Path: /v1/user/by_email

Authentication: API Key required

Description: Fetch a user from the user collection by providing their email address


parameter type description required
email string The user's email address  yes

Sample Response:

    "success": true,
    "msg": "ok",
    "data": {
        "_id": "b735b194a57bd5e37eb48698031800f8",
        "_rev": "33-d39c4b1f52273b1af6e855ffc92864dc",
        "email": "",
        "first_name": "Larry",
        "last_name": "Page",
        "active": true,
        "creation_date": "2013-05-07 10:18:37 +00:00",

Sample Error Response:

  "success": false,
  "msg": "Unable to find a user with this email address"

Docs Navigation