Skip to content
Esc
navigateopen⌘Jpreview
Dashboard

Get users by email

Get all users accounts associated with given email

GET/appid-{appId}/{tenantId}/recipe/users/by-emaildeprecated
Authorization
api-keyAPI key · headerrequired
The core service API token. If you are using a self-hosted core service and you have not generated a token, you can omit the header.
Path parameters
tenantIdstring
The tenant against which the request is made. If left empty, the default tenant will be used.
Query parameters
emailstringrequired
User's email
Header parameters
ridstring
cdi-versionstring
X.Y of the X.Y.Z CDI version.
Responses
200Get all users associated with given email
statusstatusOK
Allowed:OK
usersauthRecipeUser[]
Show properties
Array of authRecipeUser
iduserId
isPrimaryUserboolean
tenantIdstenantId[]
timeJoinedtimeJoined
emailsemail[]
phoneNumbersphoneNumber[]
thirdPartyobject[]
Show properties
Array of object
idthirdPartyId
userIdthirdPartyUserId
loginMethodsobject[]
Show properties
Array of object
tenantIdstenantId[]
recipeUserIduserId
verifiedboolean
timeJoinedtimeJoined
recipeIdrecipeId
Allowed:emailpasswordpasswordlessthirdparty
emailemail
phoneNumberphoneNumber
thirdPartyobject
Show properties
idthirdPartyId
userIdthirdPartyUserId
400error code 400
string
401error code 401
string
500error code 500
string
Try it
Server
Authorization
Parameters
Request
curl -X GET "/appid-{appId}/public/recipe/users/by-email?email=john.doe%40example.com" \
  -H "api-key: YOUR_API_KEY"
Response
{
  "status": "OK",
  "users": [
    {
      "id": "fa7a0841-b533-4478-95533-0fde890c3483",
      "isPrimaryUser": true,
      "tenantIds": [
        "customer1"
      ],
      "timeJoined": 1623918032231,
      "emails": [
        "johndoe@gmail.com"
      ],
      "phoneNumbers": [
        "+14155552671"
      ],
      "thirdParty": [
        {
          "id": "google",
          "userId": 106347997792363870000
        }
      ],
      "loginMethods": [
        {
          "tenantIds": [
            "customer1"
          ],
          "recipeUserId": "fa7a0841-b533-4478-95533-0fde890c3483",
          "verified": true,
          "timeJoined": 1623918032231,
          "recipeId": "emailpassword",
          "email": "johndoe@gmail.com",
          "phoneNumber": "+14155552671",
          "thirdParty": {
            "id": "google",
            "userId": 106347997792363870000
          }
        }
      ]
    }
  ]
}

API reference

API schema and response details