> ## 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 gVault

> Returns provisioning status and live vault details when ready.

Wait for `status: ready` before allowing deposits. Ready responses include the
contract address, fee, APY, TVL, and current instant liquidity.


## OpenAPI

````yaml swagger/swagger-combined.yaml GET /v2/gvaults/{gVaultId}
openapi: 3.0.0
info:
  title: Ground API
  description: Core API for portfolio wallets, deposits, withdrawals, 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: App-specific Ground vaults with customer access and fee sharing.
  - name: Webhook Endpoints
    description: Webhook endpoint management for portfolio wallet notifications.
paths:
  /v2/gvaults/{gVaultId}:
    parameters:
      - name: gVaultId
        in: path
        required: true
        schema:
          type: string
        description: ID returned when the gVault was created.
    get:
      tags:
        - gVaults
      summary: Get a gVault
      description: Returns provisioning status and live vault details when ready.
      operationId: getGVault
      responses:
        '200':
          description: gVault status and configuration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GVault'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: The gVault was not found for this organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  schemas:
    GVault:
      type: object
      required:
        - id
        - partnerAppId
        - vaultId
        - status
      properties:
        id:
          type: string
        partnerAppId:
          type: string
        vaultId:
          type: string
        status:
          type: string
          enum:
            - provisioning
            - ready
            - failed
        chain:
          type: string
        chainId:
          type: integer
        contractAddress:
          type: string
        assetAddress:
          type: string
        shareDecimals:
          type: integer
        feeRecipientAddress:
          type: string
        performanceFeeBps:
          type: integer
        userApyBps:
          type: integer
        feeApyBps:
          type: integer
        tvl:
          type: string
          description: Current assets in USDC native units.
        availableLiquidity:
          type: string
          description: Current synchronous withdrawal capacity in USDC native units.
    ErrorResponse:
      type: object
      required:
        - error
        - code
      properties:
        error:
          type: string
          description: >-
            Human-readable error message. May change without notice; do not
            parse programmatically.
        code:
          type: string
          description: >-
            Machine-readable error code. Stable across API versions — safe to
            switch on in client code.
          enum:
            - validation_error
            - unknown_parameters
            - unsupported_chain
            - unsupported_token
            - invalid_destination_address
            - precision_overflow
            - invalid_cursor
            - unauthenticated
            - forbidden
            - wallet_not_found
            - wallet_limit_reached
            - withdrawal_not_found
            - deposit_not_found
            - yield_source_not_found
            - wallet_projection_unavailable
            - insufficient_funds
            - duplicate_request_id
            - request_id_conflict
            - invalid_position_weight
            - invalid_withdrawal_plan
            - payout_not_found
            - webhook_not_found
            - webhook_duplicate_url
            - withdrawal_not_cancellable
            - withdrawal_already_cancelled
            - withdrawal_payout_in_progress
            - withdrawal_policy_required
            - workflow_conflict
            - payout_already_terminal
            - payout_in_progress
            - payout_not_retryable
            - address_book_entry_not_found
            - address_book_duplicate_entry
            - address_book_whitelist_violation
            - rate_limited
            - rate_limit_exceeded
            - internal_error
            - wallet_creation_failed
            - service_temporarily_unavailable
    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.
    ServiceUnavailableError:
      allOf:
        - $ref: '#/components/schemas/ErrorResponse'
        - type: object
          properties:
            retryable:
              type: boolean
              description: Whether the client should retry with the same requestId
  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
    TooManyRequests:
      description: >-
        Rate limit exceeded. Limits are enforced by API key/customer identity
        and by endpoint class. Retry with backoff; rate-limit headers are not
        currently emitted.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error: Rate limit exceeded
            code: rate_limited
    ServiceUnavailable:
      description: >-
        An upstream dependency is temporarily unavailable. The request can be
        retried with the same `requestId`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceUnavailableError'
          example:
            error: Service temporarily unavailable
            code: service_temporarily_unavailable
            retryable: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````