mirror of
https://github.com/LukeHagar/clerk-sdk-java.git
synced 2025-12-06 12:27:45 +00:00
14 lines
10 KiB
Markdown
14 lines
10 KiB
Markdown
# GetUsersCountRequest
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description |
|
|
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `emailAddress` | List<*String*> | :heavy_minus_sign: | Counts users with the specified email addresses.<br/>Accepts up to 100 email addresses.<br/>Any email addresses not found are ignored. |
|
|
| `phoneNumber` | List<*String*> | :heavy_minus_sign: | Counts users with the specified phone numbers.<br/>Accepts up to 100 phone numbers.<br/>Any phone numbers not found are ignored. |
|
|
| `externalId` | List<*String*> | :heavy_minus_sign: | Counts users with the specified external ids.<br/>Accepts up to 100 external ids.<br/>Any external ids not found are ignored. |
|
|
| `username` | List<*String*> | :heavy_minus_sign: | Counts users with the specified usernames.<br/>Accepts up to 100 usernames.<br/>Any usernames not found are ignored. |
|
|
| `web3Wallet` | List<*String*> | :heavy_minus_sign: | Counts users with the specified web3 wallet addresses.<br/>Accepts up to 100 web3 wallet addresses.<br/>Any web3 wallet addressed not found are ignored. |
|
|
| `userId` | List<*String*> | :heavy_minus_sign: | Counts users with the user ids specified.<br/>Accepts up to 100 user ids.<br/>Any user ids not found are ignored. |
|
|
| `query` | *Optional<? extends String>* | :heavy_minus_sign: | Counts users that match the given query.<br/>For possible matches, we check the email addresses, phone numbers, usernames, web3 wallets, user ids, first and last names.<br/>The query value doesn't need to match the exact value you are looking for, it is capable of partial matches as well. | |