| Field | Type | Required | Description | Example |
|---|---|---|---|---|
EmailAddress |
List<string> | ➖ | Counts users with the specified email addresses. Accepts up to 100 email addresses. Any email addresses not found are ignored. |
[ "user@example.com" ] |
PhoneNumber |
List<string> | ➖ | Counts users with the specified phone numbers. Accepts up to 100 phone numbers. Any phone numbers not found are ignored. |
[ "+1234567890" ] |
ExternalId |
List<string> | ➖ | Counts users with the specified external IDs. Accepts up to 100 external IDs. Any external IDs not found are ignored. |
[ "external-id-123" ] |
Username |
List<string> | ➖ | Counts users with the specified usernames. Accepts up to 100 usernames. Any usernames not found are ignored. |
[ "username123" ] |
Web3Wallet |
List<string> | ➖ | Counts users with the specified web3 wallet addresses. Accepts up to 100 web3 wallet addresses. Any web3 wallet addresses not found are ignored. |
[ "0x123456789abcdef" ] |
UserId |
List<string> | ➖ | Counts users with the user IDs specified. Accepts up to 100 user IDs. Any user IDs not found are ignored. |
[ "user-id-123" ] |
OrganizationId |
List<string> | ➖ | Returns users that have memberships to the given organizations. For each organization ID, the + and -can be prepended to the ID, which denote whether the respective organization should be included or excluded from the result set. Accepts up to 100 organization IDs. |
John Doe |
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 HELLO@example.com,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. |
|
NameQuery |
string | ➖ | Returns users with names that match the given query, via case-insensitive partial match. | |
Banned |
bool | ➖ | Counts users which are either banned (banned=true) or not banned (banned=false). |
|
LastActiveAtBefore |
long | ➖ | Returns users whose last session activity was before the given date (with millisecond precision). Example: use 1700690400000 to retrieve users whose last session activity was before 2023-11-23. |
1700690400000 |
LastActiveAtAfter |
long | ➖ | Returns users whose last session activity was after the given date (with millisecond precision). Example: use 1700690400000 to retrieve users whose last session activity was after 2023-11-23. |
1700690400000 |
LastActiveAtSince |
long | ➖ | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible. Returns users that had session activity since the given date. Example: use 1700690400000 to retrieve users that had session activity from 2023-11-23 until the current day. Deprecated in favor of last_active_at_after. |
1700690400000 |
CreatedAtBefore |
long | ➖ | Returns users who have been created before the given date (with millisecond precision). Example: use 1730160000000 to retrieve users who have been created before 2024-10-29. |
1730160000000 |
CreatedAtAfter |
long | ➖ | Returns users who have been created after the given date (with millisecond precision). Example: use 1730160000000 to retrieve users who have been created after 2024-10-29. |
1730160000000 |
LastSignInAtBefore |
long | ➖ | Counts users whose last sign-in was before the given date (with millisecond precision). Example: use 1700690400000 to count users whose last sign-in was before 2023-11-23. |
1700690400000 |
LastSignInAtAfter |
long | ➖ | Counts users whose last sign-in was after the given date (with millisecond precision). Example: use 1700690400000 to count users whose last sign-in was after 2023-11-23. |
1700690400000 |
Provider |
string | ➖ | Counts users with external accounts for the specified OAuth provider. Must be used in combination with the provider_user_id parameter.For example, use provider=oauth_google&provider_user_id=12345 to count users with Google provider user ID 12345.Accepts up to 100 providers. |
|
ProviderUserId |
List<string> | ➖ | Counts users with the specified provider user IDs for a specific provider. Must be used in combination with the provider parameter.For example, use provider=oauth_google&provider_user_id=12345 to count users with Google provider user ID 12345.Accepts up to 100 provider user IDs. Any provider user IDs not found are ignored. |