mirror of
https://github.com/LukeHagar/clerk-sdk-java.git
synced 2025-12-07 04:19:27 +00:00
19 lines
59 KiB
Markdown
19 lines
59 KiB
Markdown
# GetUserListRequest
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| `emailAddress` | List<*String*> | :heavy_minus_sign: | Returns 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: | Returns 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: | Returns users with the specified external ids.<br/>For each external id, the `+` and `-` can be<br/>prepended to the id, which denote whether the<br/>respective external id should be included or<br/>excluded from the result set.<br/>Accepts up to 100 external ids.<br/>Any external ids not found are ignored. | |
|
|
| `username` | List<*String*> | :heavy_minus_sign: | Returns users with the specified usernames.<br/>Accepts up to 100 usernames.<br/>Any usernames not found are ignored. | |
|
|
| `web3Wallet` | List<*String*> | :heavy_minus_sign: | Returns 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: | Returns users with the user ids specified.<br/>For each user id, the `+` and `-` can be<br/>prepended to the id, which denote whether the<br/>respective user id should be included or<br/>excluded from the result set.<br/>Accepts up to 100 user ids.<br/>Any user ids not found are ignored. | |
|
|
| `organizationId` | List<*String*> | :heavy_minus_sign: | Returns users that have memberships to the<br/>given organizations.<br/>For each organization id, the `+` and `-` can be<br/>prepended to the id, which denote whether the<br/>respective organization should be included or<br/>excluded from the result set.<br/>Accepts up to 100 organization ids. | |
|
|
| `query` | *Optional<? extends String>* | :heavy_minus_sign: | Returns 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. | |
|
|
| `lastActiveAtSince` | *Optional<? extends Long>* | :heavy_minus_sign: | Returns users that had session activity since the given date, with day precision.<br/>Providing a value with higher precision than day will result in an error.<br/>Example: use 1700690400000 to retrieve users that had session activity from 2023-11-23 until the current day. | 1700690400000 |
|
|
| `limit` | *Optional<? extends Long>* | :heavy_minus_sign: | Applies a limit to the number of results returned.<br/>Can be used for paginating the results together with `offset`. | |
|
|
| `offset` | *Optional<? extends Long>* | :heavy_minus_sign: | Skip the first `offset` results when paginating.<br/>Needs to be an integer greater or equal to zero.<br/>To be used in conjunction with `limit`. | |
|
|
| `orderBy` | *Optional<? extends String>* | :heavy_minus_sign: | Allows to return users in a particular order.<br/>At the moment, you can order the returned users by their `created_at`,`updated_at`,`email_address`,`web3wallet`,`first_name`,`last_name`,`phone_number`,`username`,`last_active_at`,`last_sign_in_at`.<br/>In order to specify the direction, you can use the `+/-` symbols prepended in the property to order by.<br/>For example, if you want users to be returned in descending order according to their `created_at` property, you can use `-created_at`.<br/>If you don't use `+` or `-`, then `+` is implied. We only support one `order_by` parameter, and if multiple `order_by` parameters are provided, we will only keep the first one. For example,<br/>if you pass `order_by=username&order_by=created_at`, we will consider only the first `order_by` parameter, which is `username`. The `created_at` parameter will be ignored in this case. | | |