getUserList()
getUserList()
Retrieves a list of users.
- Name
limit?
- Type
number
- Description
The number of results to return. Must be an integer greater than zero and less than 501.
- Name
offset?
- Type
number
- Description
The number of results to skip.
- Name
orderBy?
- Type
'created_at' | 'updated_at' | 'last_sign_in_at' | 'last_active_at'
- Description
The field to order by. Prefix with a
-
to reverse the order. Prefix with a+
to list in ascending order.
- Name
emailAddress?
- Type
string[]
- Description
The email addresses to filter by.
- Name
phoneNumber?
- Type
string[]
- Description
The phone numbers to filter by.
- Name
username?
- Type
string[]
- Description
The usernames to filter by.
- Name
web3Wallet?
- Type
string[]
- Description
The web3Wallets to filter by.
- Name
query?
- Type
string
- Description
The string to query by.
- Name
userId?
- Type
string[]
- Description
The user ID's to filter by.
- Name
externalId?
- Type
string[]
- Description
The external ID's to filter by.
Examples
Basic
In this example, you can see that the returned PaginatedResourceResponse
includes data
, which is an array of User
objects, and totalCount
, which indicates the total number of users for the application.
While the response can return up to 10 data items, for the sake of brevity, only two are shown in this example response.
Limit the number of results
Retrieves user list that is ordered and filtered by the number of results.
Filter by email addresses and phone numbers
Retrieves user list that is filtered by the given email addresses and phone numbers.
Filter by query
To do a broader match through a list of fields, you can use the query parameter which partially matches the fields: userId
, emailAddress
, phoneNumber
, username
, web3Wallet
, firstName
and lastName
.
Backend API (BAPI) endpoint
This method in the SDK is a wrapper around the BAPI endpoint GET/users
. See the BAPI reference for more details.
Feedback
Last updated on