Docs

User Search

User Search

Versionv3

User search allows you to retrieve user profile details using Auth0's Management API. Search results can be viewed, sorted, and exported.

Most user profile fields are not returned as part of an ID Token, nor are they included in the response from the /userinfo endpoint of the Authentication API.

When searching for users in Auth0, you can use multiple endpoints to search for ID, email, or other criteria:

Requirement Endpoint to Use
Searches involving user attributes Get Users
Searches returning multiple users Get Users or Get Users by Email
Operations requiring immediate consistency Get Users by ID or Get Users by Email
Actions requiring user search as part of authentication processes Get Users by ID or Get Users by Email
Searching for users for account linking by email Get Users by Email

Search Result Terminology

We use the following terms to describe the user search results:

  • Eventually consistent: Search results may not reflect a recently-completed write operation. However, if you repeat your request after a short period of time, the response will return up-to-date data.

  • Immediately consistent: Search results will reflect the results of all successful write operations, including those that occurred shortly prior to your request.

Search Best Practices

For info on best practices, see User Search Best Practices.

Keep reading