> ## 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 MicroVault pause status

Read the current pause controls for a MicroVault.

<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}/pause-status
openapi: 3.0.0
info:
  title: Ground API
  description: Core API for Portfolio Wallets, gVaults, 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: App-specific Ground vaults with customer access and fee sharing.
  - 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}/pause-status:
    parameters:
      - name: vaultId
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/UuidV4'
    get:
      tags:
        - MicroVaults
      summary: Get MicroVault pause status
      operationId: getMicrovaultPauseStatus
      responses:
        '200':
          description: Current vault and source pause flags.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MicroVaultPauseStatus'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Vault 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
    MicroVaultPauseStatus:
      type: object
      additionalProperties: false
      required:
        - flags
      properties:
        flags:
          $ref: '#/components/schemas/MicroVaultUint256'
      description: Pause flags for the MicroVault and its registered sources.
      example:
        flags: '0'
    MicroVaultError:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Stable machine-readable error code.
        message:
          type: string
          nullable: true
        details:
          nullable: true
      example:
        error: microvaults_not_enabled
        message: MicroVaults are not enabled for this organization
    MicroVaultUint256:
      type: string
      pattern: ^(0|[1-9][0-9]*)$
      description: >-
        Unsigned base-10 integer string. Asset and share amounts use token base
        units.
      example: '1000000'
    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.
  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

````