How to List and Search Users with Search Queries

​

List and search for users

• Auth0 Dashboard
• Management API

To view a list of users, go to Dashboard > User Management > Users.The search field and drop-down menu at the top of the page lets you search by the following properties:

• User
• Email
• Identity provider
• Connection
• Organization ID
• Login count
• Last login
• Phone number

You can also choose Lucene Syntax (Advanced) to specify search criteria. The search query syntax reference includes more information on supported search features and example queries.

The Management API’s List or Search Users endpoint (GET /users) is eventually consistent, so results may not immediately reflect recently-completed write operations. We recommend using this endpoint for actions that are not critically time sensitive, such as changing the display name of an existing user.

When to use the List or Search Users endpoint

• Do not use this endpoint as part of an authentication process, for account linking, or when immediate consistency is necessary. Instead, use the Management API endpoints to get users by ID or email.
• Do not use the List or Search Users endpoint to export users. Instead, use bulk user exports.

To list all users with the Management API, call the List or Search Users endpoint (GET /users). To search for users, specify search criteria with the q query parameter and a Lucene search query string.For example, to search for a user whose name is exactly example:Search queries time out (HTTP status code 503) if they don’t complete in two seconds or less. If your search query times out, it may be an expensive query or it may have an error that results in it not completing in time.The error 414 Request-URI Too Large means that your query string is larger than the supported length. In this case, refine your search.The search query syntax reference includes more information on supported search features and example queries.

​

Sort results

​

Performance recommendations

• The Management API List or Search Users endpoint returns results in a deterministic order so the same query yields the same logically ordered results each time. Non-deterministic search is faster, so if deterministic search is not necessary for your use case, use non-deterministic search by setting primary_order=false.
• Escape the space character (for example, write q=name:John Doe as q=name:John\ Doe).
• Minimize use of wildcards, especially on large data sets. When using wildcards, prefer using them as suffixes to the search term rather than prefixes.
• Avoid search criteria that return data sets with more than 1,000 results.
• Avoid existence queries (for example, “give me all users with a property regardless of its value”).
• For user-defined attributes in app_metadata and user_metadata:
  • Keep metadata fields to 2 KB or less.
  • Use consistent data types and static names for metadata properties.
  • Avoid large schema sizes and deep structures.
• Avoid user searches within login flow extension points like post-login Actions.
• Don’t poll the search APIs.

​

Limits

• Search returns a maximum of 1,000 users, even if more users match your query. When using the API, large results are paginated.
• When using the Management API’s List or Search Users endpoint, there is a 1 MB per-user limit on user data that can be indexed, queried, and returned. To retrieve all user attributes for a large user profile, get users by ID or email.
• The Management API’s List or Search Users endpoint does not support sorting by app_metadata or user_metadata.