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

# Get a MicroVault

> Returns the vault's identity, share-token metadata, current state, asset balances, and latest NAV observation.

Read vault configuration, balances, valuation, and automation status.

<Note>
  MicroVaults are in private preview for enabled sandbox organizations on Ethereum Sepolia.
</Note>


## OpenAPI

````yaml swagger/swagger-combined.yaml GET /v2/microvaults/vaults/{vaultId}
openapi: 3.0.0
info:
  title: Ground API
  description: Core API for Portfolio Wallets, gtokens, MicroVaults, and webhooks.
  version: 2.0.0
servers:
  - url: https://sandbox.groundtech.co
  - url: https://production.groundtech.co
security:
  - bearerAuth: []
tags:
  - name: System
    description: System health and utility endpoints.
  - name: Sandbox Faucets
    description: Sandbox-only test token faucets.
  - name: Portfolio Wallets
    description: >-
      Portfolio wallets with strategy allocation, deposits, withdrawals, and
      yield positions.
  - name: gVaults
    description: >-
      Direct access to gtokens with deposit access controls and optional fee
      wrappers.
  - name: MicroVaults
    description: >-
      Customer-owned onchain vaults with externally held ERC-20 shares. Private
      preview in sandbox on Ethereum Sepolia.
  - name: Webhook Endpoints
    description: Webhook endpoint management for portfolio wallet notifications.
paths:
  /v2/microvaults/vaults/{vaultId}:
    parameters:
      - name: vaultId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/UuidV4'
        description: >-
          Ground identifier of the MicroVault. This is distinct from its onchain
          contract address.
    get:
      tags:
        - MicroVaults
      summary: Get a MicroVault
      description: >-
        Returns the vault's identity, share-token metadata, current state, asset
        balances, and latest NAV observation.
      operationId: getMicrovault
      responses:
        '200':
          description: MicroVault state.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroVaultDetail'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: MicroVault not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroVaultError'
components:
  schemas:
    UuidV4:
      type: string
      format: uuid
      pattern: >-
        ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89aAbB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
      example: 8f4c52d7-62ab-4db9-a964-92f481f6b851
    MicroVaultDetail:
      type: object
      required:
        - vault
      properties:
        vault:
          allOf:
            - $ref: '#/components/schemas/MicroVault'
          description: >-
            Current identity, configuration, balances, and valuation of the
            requested MicroVault.
      example:
        vault:
          id: d9902b20-6499-4465-a4c3-5d2208182f79
          customerRecordId: 0f73a08e-8429-45a3-a149-67f212d6a746
          chainId: 11155111
          onchainCustomerId: '41'
          address: '0x848837d997f0ce3f753d4644ee51b837ab8b386e'
          factoryAddress: '0x0f62a920980b03f2fd8fec9efac6040a6595a910'
          customerVaultNonce: '3'
          version: '1'
          shareName: Acme Treasury MicroVault
          shareSymbol: acmeUSDC
          baseAssetAddress: '0x1c7d4b196cb0c7b01d743fbc6116a902379c7238'
          baseAssetDecimals: 6
          status: active
          deploymentStatus: active
          exported: false
          managementFeeBps: 0
          performanceFeeBps: 0
          feeRecipientAddress: '0x76f8fc6667e239f83a547d4e16225d6a34f6fa22'
          pauseFlags: '0'
          allocationTargets:
            - sourceId: >-
                0x1111111111111111111111111111111111111111111111111111111111111111
              targetBps: 8000
          idleTargetBps: 2000
          highWaterNavPerShare: '1000000'
          enabledSourceCount: 1
          totalAssetsUnits: '125000000'
          idleAssetsUnits: '25000000'
          freeIdleAssetsUnits: '25000000'
          reservedRedemptionAssetsUnits: '0'
          navPerShareUnits: '1002400'
          createdAt: '2026-09-01T14:30:00.000Z'
          updatedAt: '2026-09-10T18:40:00.000Z'
          nav:
            observationKind: onchain_read
            blockNumber: 9182041
            blockHash: '0xcccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc'
            totalAssetsUnits: '125000000'
            totalSupplyUnits: '124700000000000000000'
            navPerShareUnits: '1002400'
            valuationFailure: null
            observedAt: '2026-09-10T18:40:00.000Z'
          automation:
            mode: ground_managed
            health: healthy
            pendingWork: []
            blockingReason: null
            lastEvaluatedAt: '2026-09-10T18:40:10.000Z'
            lastOperationAt: '2026-09-10T17:05:00.000Z'
          authorityAddress: '0x3333333333333333333333333333333333333333'
          authorityEpoch: '1'
    MicroVaultError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          example: invalid_request
          description: Stable machine-readable error code.
        message:
          type: string
          nullable: true
          example: allocation targets and idleTargetBps must total 10000
          description: >-
            Human-readable explanation of why the request failed, when
            available.
        details:
          nullable: true
          description: Structured context for the error, when available.
      example:
        error: invalid_request
        message: allocation targets and idleTargetBps must total 10000
    MicroVault:
      type: object
      additionalProperties: true
      required:
        - id
        - chainId
        - address
        - shareName
        - shareSymbol
        - status
      properties:
        id:
          allOf:
            - $ref: '#/components/schemas/UuidV4'
          description: Ground identifier used in MicroVault API paths.
        customerRecordId:
          allOf:
            - $ref: '#/components/schemas/UuidV4'
          description: >-
            Ground identifier of the organization's MicroVault account on this
            chain.
        chainId:
          type: integer
          example: 11155111
          description: EVM chain containing the vault contract.
        onchainCustomerId:
          allOf:
            - $ref: '#/components/schemas/MicroVaultUint256'
          nullable: true
          description: Onchain customer identifier under which this vault was registered.
        address:
          allOf:
            - $ref: '#/components/schemas/NonzeroEvmAddress'
          description: Onchain vault address, which is also the ERC-20 share-token address.
        factoryAddress:
          allOf:
            - $ref: '#/components/schemas/NullableNonzeroEvmAddress'
          description: >-
            Factory that deployed the vault, or `null` before deployment data is
            available.
        customerVaultNonce:
          allOf:
            - $ref: '#/components/schemas/MicroVaultUint256'
          nullable: true
          description: Per-customer deployment nonce used to derive this vault.
        version:
          type: string
          description: Deployed MicroVault contract version.
        shareName:
          type: string
          description: Full ERC-20 name of the vault's share token.
        shareSymbol:
          type: string
          description: ERC-20 ticker of the vault's share token.
        baseAssetAddress:
          allOf:
            - $ref: '#/components/schemas/NonzeroEvmAddress'
          description: Token accepted for subscriptions and paid on redemptions.
        baseAssetDecimals:
          type: integer
          description: Decimal precision used by base-asset amounts.
        status:
          type: string
          example: active
          description: Current product state of the MicroVault.
        deploymentStatus:
          type: string
          description: Current onchain deployment and registration state.
        exported:
          type: boolean
          description: >-
            Whether vault authority has been transferred away from your
            organization's Ground-managed authority.
        managementFeeBps:
          type: integer
          description: Annual management fee in basis points.
        performanceFeeBps:
          type: integer
          description: Fee on gains above the high-water NAV in basis points.
        feeRecipientAddress:
          allOf:
            - $ref: '#/components/schemas/NullableNonzeroEvmAddress'
          description: >-
            Address that receives fee shares, or `null` before the policy is
            available.
        pauseFlags:
          allOf:
            - $ref: '#/components/schemas/MicroVaultUint256'
          description: >-
            Onchain bitmask representing pause controls. Use the pause-status
            endpoint for named controls.
        allocationTargets:
          type: array
          description: >-
            Current target allocation for each yield source with a nonzero
            target.
          items:
            type: object
            required:
              - sourceId
              - targetBps
            properties:
              sourceId:
                allOf:
                  - $ref: '#/components/schemas/MicroVaultBytes32'
                description: Yield source receiving this target.
              targetBps:
                type: integer
                description: Target share of vault assets in basis points.
        idleTargetBps:
          type: integer
          description: Target share of assets retained as idle base asset in basis points.
        highWaterNavPerShare:
          allOf:
            - $ref: '#/components/schemas/MicroVaultUint256'
          nullable: true
          description: >-
            Highest NAV per share already recognized for performance-fee
            purposes.
        enabledSourceCount:
          type: integer
          description: >-
            Number of yield sources currently attached and enabled for the
            vault.
        totalAssetsUnits:
          allOf:
            - $ref: '#/components/schemas/MicroVaultUint256'
          nullable: true
          description: >-
            Total vault value in the base asset's smallest units, net of
            redemption liabilities.
        idleAssetsUnits:
          allOf:
            - $ref: '#/components/schemas/MicroVaultUint256'
          nullable: true
          description: >-
            Base asset held directly by the vault, including any amount reserved
            for redemption.
        freeIdleAssetsUnits:
          allOf:
            - $ref: '#/components/schemas/MicroVaultUint256'
          nullable: true
          description: >-
            Idle base asset still available for allocation or immediate
            redemption after reservations.
        reservedRedemptionAssetsUnits:
          allOf:
            - $ref: '#/components/schemas/MicroVaultUint256'
          nullable: true
          description: Idle base asset already assigned to pending requested redemptions.
        navPerShareUnits:
          allOf:
            - $ref: '#/components/schemas/MicroVaultUint256'
          nullable: true
          description: >-
            Base-asset value of one whole MicroVault share, scaled by the base
            asset's decimals.
        nav:
          allOf:
            - $ref: '#/components/schemas/MicroVaultNav'
          nullable: true
          description: >-
            Latest detailed valuation observation, or `null` before the first
            observation.
        automation:
          type: object
          nullable: true
          description: >-
            Ground-management state for the vault, or `null` before automation
            is initialized.
          properties:
            mode:
              type: string
              enum:
                - ground_managed
                - ground_delegated
                - customer_operated
              description: Authority model responsible for ongoing vault operations.
            health:
              type: string
              enum:
                - healthy
                - working
                - degraded
                - action_required
              description: >-
                Whether automation is idle, processing work, degraded, or
                requires intervention.
            pendingWork:
              type: array
              items:
                type: object
                additionalProperties: true
              description: >-
                Authorized strategy, rebalance, or redemption work not yet
                complete.
            blockingReason:
              type: string
              nullable: true
              description: >-
                Reason automation cannot proceed, or `null` when it is not
                blocked.
            lastEvaluatedAt:
              type: string
              format: date-time
              nullable: true
              description: Last time Ground evaluated the vault for work.
            lastOperationAt:
              type: string
              format: date-time
              nullable: true
              description: Last time automation performed a vault operation.
        authorityAddress:
          allOf:
            - $ref: '#/components/schemas/NonzeroEvmAddress'
          description: >-
            Current address authorized to administer the vault. Present on the
            vault-detail response.
        authorityEpoch:
          allOf:
            - $ref: '#/components/schemas/MicroVaultUint256'
          nullable: true
          description: >-
            Onchain revision of the current authority assignment. Present on the
            vault-detail response.
        createdAt:
          type: string
          format: date-time
          description: Time when Ground created the vault record.
        updatedAt:
          type: string
          format: date-time
          description: Time when the vault record last changed.
      example:
        id: d9902b20-6499-4465-a4c3-5d2208182f79
        customerRecordId: 0f73a08e-8429-45a3-a149-67f212d6a746
        chainId: 11155111
        onchainCustomerId: '41'
        address: '0x848837d997f0ce3f753d4644ee51b837ab8b386e'
        factoryAddress: '0x0f62a920980b03f2fd8fec9efac6040a6595a910'
        customerVaultNonce: '3'
        version: '1'
        shareName: Acme Treasury MicroVault
        shareSymbol: acmeUSDC
        baseAssetAddress: '0x1c7d4b196cb0c7b01d743fbc6116a902379c7238'
        baseAssetDecimals: 6
        status: active
        deploymentStatus: active
        exported: false
        managementFeeBps: 0
        performanceFeeBps: 0
        feeRecipientAddress: '0x76f8fc6667e239f83a547d4e16225d6a34f6fa22'
        pauseFlags: '0'
        allocationTargets:
          - sourceId: '0x1111111111111111111111111111111111111111111111111111111111111111'
            targetBps: 8000
        idleTargetBps: 2000
        highWaterNavPerShare: '1000000'
        enabledSourceCount: 1
        totalAssetsUnits: '125000000'
        idleAssetsUnits: '25000000'
        freeIdleAssetsUnits: '25000000'
        reservedRedemptionAssetsUnits: '0'
        navPerShareUnits: '1002400'
        createdAt: '2026-09-01T14:30:00.000Z'
        updatedAt: '2026-09-10T18:40:00.000Z'
        nav:
          observationKind: onchain_read
          blockNumber: 9182041
          blockHash: '0xcccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccccc'
          totalAssetsUnits: '125000000'
          totalSupplyUnits: '124700000000000000000'
          navPerShareUnits: '1002400'
          valuationFailure: null
          observedAt: '2026-09-10T18:40:00.000Z'
        automation:
          mode: ground_managed
          health: healthy
          pendingWork: []
          blockingReason: null
          lastEvaluatedAt: '2026-09-10T18:40:10.000Z'
          lastOperationAt: '2026-09-10T17:05:00.000Z'
    AuthErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Authentication or authorization error message.
        message:
          type: string
          nullable: true
          description: Additional auth middleware detail, when present.
        code:
          type: string
          nullable: true
          enum:
            - unauthenticated
            - forbidden
          description: >-
            Some auth and scope failures include a stable code; middleware
            errors may omit it.
    MicroVaultUint256:
      type: string
      pattern: ^(0|[1-9][0-9]*)$
      description: Unsigned base-10 integer in token base units.
      example: '1000000'
    NonzeroEvmAddress:
      type: string
      description: >-
        Valid nonzero EVM EOA or contract address. Mixed-case values must use a
        valid EIP-55 checksum.
      minLength: 42
      maxLength: 42
      pattern: ^0x(?!0{40}$)[0-9a-fA-F]{40}$
      example: '0x3bf25a73a1f1033c2d50ac65f3c9d6a44123db81'
    NullableNonzeroEvmAddress:
      type: string
      nullable: true
      description: >-
        Deployed nonzero EVM contract address, or null while deployment is
        pending.
      minLength: 42
      maxLength: 42
      pattern: ^0x(?!0{40}$)[0-9a-fA-F]{40}$
      example: '0x7c4a1cb5a3d5c3c4e019c3f6ab29a0f98c21b814'
    MicroVaultBytes32:
      type: string
      pattern: ^0x[0-9a-fA-F]{64}$
      example: '0x1111111111111111111111111111111111111111111111111111111111111111'
    MicroVaultNav:
      type: object
      additionalProperties: true
      properties:
        observationKind:
          type: string
          enum:
            - onchain_read
            - valuation_failed
            - legacy_computed
          description: Method or outcome of the latest vault valuation.
        blockNumber:
          type: integer
          nullable: true
          description: >-
            Block number used for this valuation, or `null` when no onchain
            observation is available.
        blockHash:
          type: string
          nullable: true
          pattern: ^0x[0-9a-fA-F]{64}$
          description: >-
            Hash of the block used for this valuation, or `null` when
            unavailable.
        totalAssetsUnits:
          allOf:
            - $ref: '#/components/schemas/MicroVaultUint256'
          nullable: true
          description: >-
            Total vault value in the base asset's smallest units, net of
            redemption liabilities.
        totalSupplyUnits:
          allOf:
            - $ref: '#/components/schemas/MicroVaultUint256'
          nullable: true
          description: Outstanding MicroVault shares in 18-decimal share-token units.
        navPerShareUnits:
          allOf:
            - $ref: '#/components/schemas/MicroVaultUint256'
          nullable: true
          description: >-
            Base-asset value of one whole share, scaled by the base asset's
            decimals.
        valuationFailure:
          nullable: true
          description: >-
            Structured reason the vault could not be fully valued, or `null`
            after a successful valuation.
        observedAt:
          type: string
          format: date-time
          nullable: true
          description: >-
            Block time of the latest valuation, or `null` when no valuation is
            available.
  responses:
    Unauthorized:
      description: >-
        The request is missing a valid bearer token, or the token is invalid or
        expired.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/AuthErrorResponse'
          example:
            error: Unauthenticated request
            message: Missing or invalid bearer token
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````