> ## Documentation Index
> Fetch the complete documentation index at: https://sure-917046f5-mintlify-docs-update-1787380016881.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve reset status

> Returns counts of family-owned data targeted by account reset. Use this after DELETE /api/v1/users/reset to decide whether reset materialization has completed. Completion is a counts-based family snapshot and may change if new data is created after reset.



## OpenAPI

````yaml /openapi.yaml get /api/v1/users/reset/status
openapi: 3.0.3
info:
  title: Sure API
  version: v1
  description: OpenAPI documentation generated from executable request specs.
servers:
  - url: https://app.sure.am
    description: Production
  - url: http://localhost:3000
    description: Local development
security: []
paths:
  /api/v1/users/reset/status:
    get:
      tags:
        - Users
      summary: Retrieve reset status
      description: >-
        Returns counts of family-owned data targeted by account reset. Use this
        after DELETE /api/v1/users/reset to decide whether reset materialization
        has completed. Completion is a counts-based family snapshot and may
        change if new data is created after reset.
      responses:
        '200':
          description: reset status returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResetStatusResponse'
        '401':
          description: unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: forbidden - requires admin role
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - apiKeyAuth: []
components:
  schemas:
    ResetStatusResponse:
      type: object
      required:
        - status
        - family_id
        - reset_complete
        - counts
      properties:
        status:
          type: string
          enum:
            - complete
            - data_remaining
          description: Counts-based family reset status at response time.
        family_id:
          type: string
          format: uuid
          description: UUID of the family whose reset target counts were checked.
        reset_complete:
          type: boolean
          description: >-
            True when all reset target counts are zero at response time. This is
            a family data snapshot, not a durable per-job completion record.
        counts:
          type: object
          required:
            - account_statements
            - family_exports
            - imports
            - import_sessions
            - import_source_mappings
            - import_rows
            - import_mappings
            - accounts
            - account_shares
            - account_providers
            - entries
            - transactions
            - transfers
            - rejected_transfers
            - valuations
            - trades
            - holdings
            - balances
            - recurring_transactions
            - rules
            - rule_actions
            - rule_conditions
            - rule_runs
            - budgets
            - budget_categories
            - categories
            - tags
            - taggings
            - merchants
            - family_merchant_associations
            - provider_items
            - active_storage_attachments
            - plaid_items
          additionalProperties:
            type: integer
            minimum: 0
          properties:
            account_statements:
              type: integer
              minimum: 0
            family_exports:
              type: integer
              minimum: 0
            imports:
              type: integer
              minimum: 0
            import_sessions:
              type: integer
              minimum: 0
            import_source_mappings:
              type: integer
              minimum: 0
            import_rows:
              type: integer
              minimum: 0
            import_mappings:
              type: integer
              minimum: 0
            accounts:
              type: integer
              minimum: 0
            account_shares:
              type: integer
              minimum: 0
            account_providers:
              type: integer
              minimum: 0
            entries:
              type: integer
              minimum: 0
            transactions:
              type: integer
              minimum: 0
            transfers:
              type: integer
              minimum: 0
            rejected_transfers:
              type: integer
              minimum: 0
            valuations:
              type: integer
              minimum: 0
            trades:
              type: integer
              minimum: 0
            holdings:
              type: integer
              minimum: 0
            balances:
              type: integer
              minimum: 0
            recurring_transactions:
              type: integer
              minimum: 0
            rules:
              type: integer
              minimum: 0
            rule_actions:
              type: integer
              minimum: 0
            rule_conditions:
              type: integer
              minimum: 0
            rule_runs:
              type: integer
              minimum: 0
            budgets:
              type: integer
              minimum: 0
            budget_categories:
              type: integer
              minimum: 0
            categories:
              type: integer
              minimum: 0
            tags:
              type: integer
              minimum: 0
            taggings:
              type: integer
              minimum: 0
            merchants:
              type: integer
              minimum: 0
            family_merchant_associations:
              type: integer
              minimum: 0
            provider_items:
              type: integer
              minimum: 0
            active_storage_attachments:
              type: integer
              minimum: 0
            plaid_items:
              type: integer
              minimum: 0
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        message:
          type: string
          nullable: true
        details:
          oneOf:
            - type: array
              items:
                type: string
            - type: object
          nullable: true
        errors:
          type: array
          items:
            type: string
          nullable: true
          description: >-
            Validation error messages (alternative to details used by trades,
            valuations, etc.)
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: X-Api-Key
      in: header
      description: API key for authentication. Generate one from your account settings.

````