| Field | Type | Required | Description |
|---|---|---|---|
emailAddress |
array<string> | ➖ | Counts users with the specified email addresses. Accepts up to 100 email addresses. Any email addresses not found are ignored. |
phoneNumber |
array<string> | ➖ | Counts users with the specified phone numbers. Accepts up to 100 phone numbers. Any phone numbers not found are ignored. |
externalId |
array<string> | ➖ | Counts users with the specified external ids. Accepts up to 100 external ids. Any external ids not found are ignored. |
username |
array<string> | ➖ | Counts users with the specified usernames. Accepts up to 100 usernames. Any usernames not found are ignored. |
web3Wallet |
array<string> | ➖ | Counts users with the specified web3 wallet addresses. Accepts up to 100 web3 wallet addresses. Any web3 wallet addressed not found are ignored. |
userId |
array<string> | ➖ | Counts users with the user ids specified. Accepts up to 100 user ids. Any user ids not found are ignored. |
query |
?string | ➖ | Counts users that match the given query. For possible matches, we check the email addresses, phone numbers, usernames, web3 wallets, user ids, first and last names. The query value doesn't need to match the exact value you are looking for, it is capable of partial matches as well. |
emailAddressQuery |
?string | ➖ | Counts users with emails that match the given query, via case-insensitive partial match. For example, email_address_query=ello will match a user with the email [email protected],and will be included in the resulting count. |
phoneNumberQuery |
?string | ➖ | Counts users with phone numbers that match the given query, via case-insensitive partial match. For example, phone_number_query=555 will match a user with the phone number +1555xxxxxxx,and will be included in the resulting count. |
usernameQuery |
?string | ➖ | Counts users with usernames that match the given query, via case-insensitive partial match. For example, username_query=CoolUser will match a user with the username SomeCoolUser,and will be included in the resulting count. |
banned |
?bool | ➖ | Counts users which are either banned (banned=true) or not banned (banned=false). |