Skip to content

Get Accounts By Group

GetAccountsByGroup

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
group_mask string No Filter account by group name (default is "*")

Request Example

{
  "group_mask": "STD-*"
}

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

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]", "..."]
  ]
}