STstytch
User

Search

Changed on

Warning: This endpoint is not recommended for use in login flows. Scaling issues may occur, as search performance may vary from ~150 milliseconds to 9 seconds depending on query complexity and rate limits are set to 150 requests/minute.

Search for Users within your Stytch Project.

Use the query object to filter by different fields. See the query.operands.filter_value documentation below for a list of available filters.

Export all User data

Submit an empty query in your Search Users request to return all of your Stytch Project's Users.

This Github repository contains a utility that leverages the Search Users endpoint to export all of your User data to a CSV or JSON file.

post/v1/users/search

Request

  • Base URL
    https://api.stytch.com
  • Auth
    HTTP basic

Request body

cursorstring

The cursor field allows you to paginate through your results. Each result array is limited to 1000 results. If your query returns more than 1000 results, you will need to paginate the responses using the cursor. If you receive a response that includes a non-null next_cursor in the results_metadata object, repeat the search call with the next_cursor value set to the cursor field to retrieve the next page of results. Continue to make search calls until the next_cursor in the response is null.

limitinteger

The number of search results to return per page. The default limit is 100. A maximum of 1000 results can be returned by a single search request. If the total size of your result set is greater than one page size, you must paginate the response. See the cursor field.

Response

Successful response

request_idstring required

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.

status_codeinteger required

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.

Changes