Users settings

Contains the configuration of the parameters that apply to the users within a company profile.

Gets/retrieves users configuration within a company profile

GET https://api.aquanow.io/users/v1/companyProfile/users

Name	Type	Description
user	String	The username of the user. If no user is provided, fetches all users within a company profile

Headers

Name	Type	Description
x-api-key*	String	{{x-api-key}} API Auth Key
x-signature*	String	49c6260c194f4d7ed5cb917dc70b9821673246b2abc1cf28f05df6a75fd24181e00f8e57b321d15ae45db58b3bffe27a Signature created using your API secret
x-nonce*	Number	1657731573930 Timestamp in millisecond

200: OK Get company profile users

Returns an array of CompanyProfileAccountsObject

{
    "data": {
        "usersList": [
            {
                "username": "user1",
                "email": "[email protected]",
                "canApprove": true,
                "canEditSettings": false,
                "withdrawalAccess": "approvalRequired",
                "canTrade": true,
                "permissionedAccounts": [
                    {
                        "accountId": "CA1000051R"
                    },
                    {
                        "accountId": "CA1000052R"
                    }
                ]
            },
            {
                "username": "user2",
                "email": "[email protected]",
                "canApprove": false,
                "canEditSettings": true,
                "withdrawalAccess": "directAccess",
                "canTrade": false,
                "permissionedAccounts": [
                    {
                        "accountId": "CA1000051R"
                    }
                ]
            }
        ]
    }
}

200: OK Get company profile users with accountId

Returns an array of CompanyProfileUsersObject

{
  "data": {
    "usersList": [
      {
        "username": "user1",
        "email": "[email protected]",
        "canApprove": true,
        "canEditSettings": false,
        "withdrawalAccess": "approvalRequired",
        "canTrade": true,
        "permissionedAccounts": [
          {
            "accountId": "CA1000051R"
          },
          {
            "accountId": "CA1000052R"
          }
        ]
      }
    ]
  }
}

500: Could not find any users under username

{
    "message": "Could not find any accounts under user: rylan4"
}