List users

get

https://wealth-rest-api.softwarealgo.com/v1/user/list

Lists all users based on the given filters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

email address of the user

name

string

User's full name

userType

string

Check /v1/systemcode/list API for valid values (type = 'User Type'), use the 'code' value.

status

string

Check /v1/systemcode/list API for valid values (type: 'Status', subType = 'User Setup'), use the 'code' value.

roleId

int64

Unique identification number of the user's role

isPendingClients

boolean

Set to true to filter only users with status 'For Review', 'In Progress', 'Pending'

pagination.pageSize

int64

Number of records to return per page. Used to control the size of each paginated response.

pagination.pageNo

int64

Zero-based index of the page to retrieve. For example, page_no = 0 returns the first page.

pagination.sortName

string

Name of the field to sort by. Leave empty for default sorting behavior.

pagination.sortDirection

string

Sorting order for the results. Acceptable values are 'asc' for ascending and 'desc' for descending.

pagination.filterNames

array of strings

List of field names to apply filters on. Must correspond to valid queryable fields.

pagination.filterNames

pagination.filterValues

array of strings

List of values corresponding to each filter name. The position of each value must match the position of its filter name.

pagination.filterValues

Response

200A successful response.