Skip to main content
GET
/
platform
/
admin
/
tenant
/
wallets
Get full wallets report
curl --request GET \
  --url https://api.example.com/platform/admin/tenant/wallets
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

Fetches a complete report of all wallets associated with the platform tenant, including wallet balances, blockchain networks, addresses, and configuration details.

​
Input

No input parameters required. The tenant context is determined from the authenticated session.

​
Output

Returns a containing:
  • wallets (array) - Collection of wallet reports with detailed information
  • totalCount (int) - Total number of wallets
  • activeCount (int) - Number of active wallets
  • inactiveCount (int) - Number of inactive wallets

​
Examples

Request 
GET /api/platform/wallets
Response (200 OK) 
{
  "wallets": [
    {
      "walletTenantId": 2048,
      "walletName": "Main Wallet",
      "walletAddress": "0x1234567890abcdef1234567890abcdef12345678",
      "blockchainId": 137,
      "blockchainName": "Polygon",
      "walletType": "EOA",
      "isActive": true,
      "isVisible": true,
      "isTreasury": false,
      "balance": "1500.25"
    },
    {
      "walletTenantId": 3001,
      "walletName": "MultiSig Treasury",
      "walletAddress": "0xabcdef1234567890abcdef1234567890abcdef12",
      "blockchainId": 1,
      "blockchainName": "Ethereum",
      "walletType": "MultiSignature",
      "isActive": true,
      "isVisible": true,
      "isTreasury": true,
      "threshold": 2,
      "ownersCount": 3,
      "balance": "50000.00"
    }
  ],
  "totalCount": 2,
  "activeCount": 2,
  "inactiveCount": 0
}

​
Errors

  • 401 Unauthorized: Authentication token is missing or invalid.
  • 403 Forbidden: User does not have permission to view wallet reports.
  • 500 Internal Server Error: An unexpected error occurred while generating the report.

​
Notes

This endpoint returns all wallets regardless of type (EOA or multisignature). The report includes both active and inactive wallets. Balance information is retrieved from the blockchain in real-time.

Query Parameters

​
api-version
string | null

Response

Wallets report retrieved successfully.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.