Auth0 API | Users By Email › Search Users By Email

Users By Email

users_by_email

Methods

Search Users By Email -> Array<{ app_metadata, blocked, created_at, 18 more... }>

get/users-by-email

Find users by email. If Auth0 is the identity provider (idP), the email address associated with a user is saved in lower case, regardless of how you initially provided it.

For example, if you register a user as JohnSmith@example.com, Auth0 saves the user's email as johnsmith@example.com.

Therefore, when using this endpoint, make sure that you are searching for users via email addresses using the correct case.

Security

Example: Authorization: Bearer My Bearer Token

Parameters

email: string

Email address to search for (case-sensitive).

fields: string

Optional

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

include_fields: boolean

Optional

Whether specified fields are to be included (true) or excluded (false). Defaults to true.

Request example

curl https://login0.local.dev.auth0.com/api/v2/users-by-email \
    -H "Authorization: Bearer $BEARER_TOKEN" \
    -d '{}'

200Example

[
  {
    "app_metadata": {
      "foo": "bar"
    },
    "blocked": true,
    "created_at": "string",
    "email": "dev@stainlessapi.com",
    "email_verified": true,
    "family_name": "family_name",
    "given_name": "given_name",
    "identities": [
      {
        "access_token": "access_token",
        "access_token_secret": "access_token_secret",
        "connection": "connection",
        "isSocial": true,
        "profileData": {
          "email": "email",
          "email_verified": true,
          "family_name": "family_name",
          "given_name": "given_name",
          "name": "name",
          "phone_number": "phone_number",
          "phone_verified": true,
          "username": "username"
        },
        "provider": "ad",
        "refresh_token": "refresh_token",
        "user_id": "user_id"
      }
    ],
    "last_ip": "last_ip",
    "last_login": "string",
    "logins_count": 0,
    "multifactor": [
      "string"
    ],
    "name": "name",
    "nickname": "nickname",
    "phone_number": "phone_number",
    "phone_verified": true,
    "picture": "picture",
    "updated_at": "string",
    "user_id": "user_id",
    "user_metadata": {
      "foo": "bar"
    },
    "username": "username"
  }
]