Skip to content

Get users by group#

About#

Get users by group.

GET /users/current/mt5/provisioning-profiles/:profileId/groups/:groupName/users

For more information see swagger documentation

Headers#

Name Type Required Description
auth-token string Yes MetaApi account token. See Authentication & authorization

Path parameters#

Name Type Required Description
profileId string Yes Id of the provisioning profile that will be used as the basis
groupName string Yes Group name

Response#

  • 200 - Successfully retrieved users by group. Response schema: MetatraderUser
  • 400 - Validation failed. Response schema: Error
  • 401 - Authorization failed. Response schema: Error

Examples#

Example request:

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'auth-token: token' -d '{}' 'https://mt-manager-api-v1.vint-hill.agiliumtrade.ai/users/current/mt5/provisioning-profiles/profileId/groups/Example\\Group/users'

Example response:

[
  {
    "login": "86053193",
    "address": "30 N Gould Street",
    "balance": "100",
    "city": "Sheridan",
    "country": "USA",
    "email": "agiliumtrade@agiliumtrade.ai",
    "group": "Example\\Group",
    "leverage": "100",
    "name": "Example User",
    "phone": "+1(303)327-9699",
    "state": "Wyoming",
    "zip": "6200",
    "leadSource": "Lead source",
    "leadCampaign": "Lead campaign",
    "clientId": "Client ID"
  }
]