SUsuperwall
Users V2

List Users

Changed on

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

  • Base URL
    https://api.superwall.com
  • URL
    https://api.superwall.com/v2/users/query
  • Auth
    • HTTP bearer
    • or API key in cookie accounts_superwall_token
    • or HTTP bearer

Request body

application_idstring required
match_mode'all' | 'any'
search_termstring

Case-insensitive substring match against app_user_id

is_downloadboolean

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

rowsSuperwallApiSchemaV2JsonObject[] required

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

Changes

  • 778a11cd2c15Revision changes
    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 from the response body anyOf list for the response status

  • 217c96dc9a29Revision changes
    • breaking

      removed the enum value all of the request property

    • breaking

      removed the enum value any of the request property

    • breaking

      the request property type changed from array to no type

    • breaking

      the request property type changed from boolean to no type

    • breaking

      the request property type changed from string to no type

    • breaking

      the request property type changed from string to no type

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from number to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    This list may be incomplete.