Skip to content

Files

Latest commit

 

History

History
28 lines (25 loc) · 96.8 KB

getuserlistrequest.md

File metadata and controls

28 lines (25 loc) · 96.8 KB

GetUserListRequest

Fields

Field Type Required Description Example
email_address List[str] ➖ Returns users with the specified email addresses.
Accepts up to 100 email addresses.
Any email addresses not found are ignored.		 [
"test@example.com"
]
phone_number List[str] ➖ Returns users with the specified phone numbers.
Accepts up to 100 phone numbers.
Any phone numbers not found are ignored.		 [
"+12345678901"
]
external_id List[str] ➖ Returns users with the specified external ids.
For each external id, the + and - can be
prepended to the id, which denote whether the
respective external id should be included or
excluded from the result set.
Accepts up to 100 external ids.
Any external ids not found are ignored.		 [
"external-id-123"
]
username List[str] ➖ Returns users with the specified usernames.
Accepts up to 100 usernames.
Any usernames not found are ignored.		 [
"user123"
]
web3_wallet List[str] ➖ Returns users with the specified web3 wallet addresses.
Accepts up to 100 web3 wallet addresses.
Any web3 wallet addressed not found are ignored.		 [
"0x123456789abcdef0x123456789abcdef"
]
user_id List[str] ➖ Returns users with the user ids specified.
For each user id, the + and - can be
prepended to the id, which denote whether the
respective user id should be included or
excluded from the result set.
Accepts up to 100 user ids.
Any user ids not found are ignored.		 [
"user-id-123"
]
organization_id List[str] ➖ 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.		 [
"org-id-123"
]
query Optional[str] ➖ Returns 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.		 John
email_address_query Optional[str] ➖ Returns 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.
phone_number_query Optional[str] ➖ Returns 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.
username_query Optional[str] ➖ Returns 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.
name_query Optional[str] ➖ Returns users with names that match the given query, via case-insensitive partial match.
banned Optional[bool] ➖ Returns users which are either banned (banned=true) or not banned (banned=false).
last_active_at_before Optional[int] ➖ 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
last_active_at_after Optional[int] ➖ 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
last_active_at_since Optional[int] ➖ : 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
created_at_before Optional[int] ➖ 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
created_at_after Optional[int] ➖ 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
limit Optional[int] ➖ Applies a limit to the number of results returned.
Can be used for paginating the results together with offset.		 20
offset Optional[int] ➖ Skip the first offset results when paginating.
Needs to be an integer greater or equal to zero.
To be used in conjunction with limit.		 10
order_by Optional[str] ➖ Allows to return users in a particular order.
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.
In order to specify the direction, you can use the +/- symbols prepended in the property to order by.
For example, if you want users to be returned in descending order according to their created_at property, you can use -created_at.
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,
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.