> ## Documentation Index
> Fetch the complete documentation index at: https://docs.range.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Balances for Workspace Accounts

> Returns current balances for all accounts stored in the workspace, filtered by the workspace's token whitelist by default. Pass show_all=true to restore the unfiltered response. Each entry includes `account_id` matching `AccountDto.id` for stable joins; multisig accounts expose their real on-chain address and canonical network.



## OpenAPI

````yaml /api-reference/platform-api.json get /v2/addresses/workspace/balances
openapi: 3.0.0
info:
  title: Range Platform API
  description: >-
    The Range Platform API for workspace management, counterparties, and
    operational tooling.
  version: 1.7.29
  contact: {}
servers:
  - url: https://api.range.org
    description: Range API Server
security:
  - Authorization: []
  - Authorization: []
tags:
  - name: Address Information
    description: Get information about a crypto address.
  - name: Transfer Enrichments
    description: Attach workspace-scoped notes and categories to transfers.
  - name: Counterparties
    description: Manage external entities, their addresses, bank accounts, and documents.
  - name: Parties
    description: >-
      The workspace entity register: the firm itself, its clients, and its
      counterparties.
paths:
  /v2/addresses/workspace/balances:
    get:
      tags:
        - Address Information
      summary: Get Balances for Workspace Accounts
      description: >-
        Returns current balances for all accounts stored in the workspace,
        filtered by the workspace's token whitelist by default. Pass
        show_all=true to restore the unfiltered response. Each entry includes
        `account_id` matching `AccountDto.id` for stable joins; multisig
        accounts expose their real on-chain address and canonical network.
      operationId: getWorkspaceBalances
      parameters:
        - name: show_all
          required: false
          in: query
          description: >-
            Restores the response to today's unfiltered shape, byte-for-byte,
            ignoring the workspace token whitelist. Never mutates stored
            overrides.
          schema:
            default: false
            type: boolean
      responses:
        '200':
          description: Balances for each account in the workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceBalancesResponseDto'
components:
  schemas:
    WorkspaceBalancesResponseDto:
      type: object
      properties:
        balances:
          type: array
          items:
            $ref: '#/components/schemas/WorkspaceAccountBalanceDto'
      required:
        - balances
    WorkspaceAccountBalanceDto:
      type: object
      properties:
        address:
          type: string
          example: cosmos1abc...
        network:
          type: string
          example: cosmoshub-4
          description: >-
            Canonical Range network slug for on-chain balances (ADR-0003).
            Off-chain accounts (exchange/bank/custodian with no chain) use the
            sentinel `off_chain`.
        assets:
          type: array
          items:
            $ref: '#/components/schemas/AssetBalanceDto'
        hidden_count:
          type: number
          example: 0
          description: >-
            RNG-5741: count of assets the workspace token whitelist removed from
            `assets` above. `0` both when nothing was filtered and when this
            entry genuinely holds nothing — distinguish those with
            `assets.length`. Always `0` when `show_all` was requested. Always
            present, including when nothing was hidden.
        updated_at:
          type: string
          example: '2024-01-01T00:00:00.000Z'
          description: >-
            When these balances were last refreshed. Omitted when never
            refreshed.
        account_id:
          type: string
          example: bje5mmbqxjvwjaf7oxwpyxntxdyspzZyt4vwennw5rug
          description: >-
            Stable join key matching `AccountDto.id`. Present on every workspace
            balance so clients can join balances ↔ accounts without relying on
            address/network identity.
        last_balance_refresh_at:
          type: object
          example: '2026-01-01T00:00:00.000Z'
          nullable: true
          description: >-
            When the most recent balance-*refresh attempt* ran, or null before
            the first one. Advances on every attempt including a failed one —
            unlike `updated_at` above, which only moves on a successful read.
            Always present, matching `AccountDto.last_balance_refresh_at` (same
            underlying resolver, so the two surfaces cannot drift).
        last_balance_refresh_reason:
          type: string
          nullable: true
          example: provider_timeout
          enum:
            - reconnect_required
            - provider_timeout
            - rate_limited
            - authentication_failed
            - provider_unreachable
            - provider_rejected
            - provider_error
            - connection_not_found
            - balance_lookup_failed
            - unclassified_provider_error
            - asset_catalog_unavailable
            - tokens_not_enumerated
          description: >-
            Why the most recent balance-refresh attempt failed, as a stable
            machine code. null when the last attempt succeeded, none has been
            made yet, or the chain has no readable balance source. Always
            present, matching `AccountDto.last_balance_refresh_reason`.
        last_balance_refresh_status:
          type: string
          nullable: true
          example: succeeded
          enum:
            - succeeded
            - failed
            - unsupported
          description: >-
            Outcome of the most recent balance-refresh attempt for the account
            behind this balance. `unsupported` means this chain has no readable
            balance source — derived, and takes precedence over any stored
            status. null before the first attempt. Always present, matching
            `AccountDto.last_balance_refresh_status` (same underlying resolver,
            so the two surfaces cannot drift).
      required:
        - address
        - network
        - assets
        - hidden_count
        - account_id
        - last_balance_refresh_at
        - last_balance_refresh_reason
        - last_balance_refresh_status
    AssetBalanceDto:
      type: object
      properties:
        symbol:
          type: string
          example: USDC
          description: Asset ticker / symbol. Always present.
        name:
          type: string
          example: USD Coin
          description: >-
            Human-readable asset name. Always present; falls back to `symbol`
            when a distinct name is unavailable.
        amount:
          type: string
          example: '100.50'
          description: >-
            Quantity in asset units as a decimal string (avoids float precision
            loss).
        usd:
          type: string
          nullable: true
          example: '100.50'
          description: >-
            USD value as a decimal string. `null` means the price is unknown
            (distinct from `"0"`, which is a known zero value).
      required:
        - symbol
        - name
        - amount
        - usd
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Authorization method required to allow user to access the api endpoints.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.