Get Accounts List

GetUsersByFilter

Description: Retrieves a list of user accounts with financial and profile data. Supports filtering by group and returns aggregate totals.

Request Parameters

Name	Type	Required	Description
groupFilter	string	No	Filter users by group name (default is "*")
where	array	No	Filter by rule
whereNot	array	No	Filter by rule
whereIn	array	No	Filter by rule
whereNotIn	array	No	Filter by rule
whereBetween	array	No	Filter by rule
whereNotBetween	array	No	Filter by rule

---

Supported Filter Keys

Filter Key	Format	Description
where	[[field, operator, value], ...]	Simple comparisons using operators like ==, >, <, etc.
whereNot	[[field, value], ...]	Negated equality comparisons (!=)
whereIn	[[field, [value1, value2, ...]], ...]	Field must match one of the values in the list
whereNotIn	[[field, [value1, value2, ...]], ...]	Field must not match any of the values in the list
whereBetween	[[field, [min, max]], ...]	Field value must be within the range [min, max]
whereNotBetween	[[field, [min, max]], ...]	Field value must be outside the range [min, max]

---

Operators Supported in where

• "==" or "=": Equal to
• "!=": Not equal to
• ">" / "<" / ">=" / "<=": Numeric comparisons
• "like": Case-sensitive substring match using SQL-style % wildcard

---

Request Example

{
  "groupFilter": "standard"
}

Response Parameters

Name	Type	Description
structure	array	Array of field names representing each column in rows
rows	array	Array of user records with profile and financial info
count	int	Total number of users returned
total_balance	double	Aggregated balance across all users
total_credit	double	Aggregated credit across all users

Row Fields (structure array)

• login
• enable
• enable_read_only
• enable_change_password
• leverage
• currency
• group
• email
• country
• phone
• comment
• address
• city
• zipcode
• name
• regdate
• prevbalance
• prevmonthbalance
• balance
• credit
• margin
• margin_free
• margin_level
• equity

Response Example

{
  "structure": ["login", "enable", "leverage", "currency", "..."],
  "rows": [
    [102030, 1, 200, "USD", "standard", "[email protected]", "..."]
  ],
  "count": 1,
  "total_balance": 12500.00,
  "total_credit": 1500.00
}