Sign in
Users V2

List Users

Query users with filters, search term, and a download flag. Returns dynamic attribute columns alongside each user row (app_user_id, a nested properties object, and flattened attributes). Requires users:read scope.

post/v2/users/query

Request body

application_idstring required

Application ID

match_mode'all' | 'any'

Whether a row must match all filters or any of them

search_termstring
is_downloadboolean

When true, raises the row limit for CSV export

Response

Success

object'user_query_result' required
totalnumber required

Total users in the application

returned_countnumber required

Users returned in this page

filtered_totalnumber required

Users matching the filters after the search term is applied

time_elapsednumber required

Query duration in seconds

rowsSuperwall1apiSchema1v21JsonObject[] required— unresolved $ref

User rows; each has app_user_id, a nested properties object, and flattened attributes

Changes