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

# Get v1household



## OpenAPI

````yaml https://external.vin.gs/api/openapi.json get /v1/household
openapi: 3.1.0
info:
  title: Vings External API
  version: 0.1.0
  description: >-
    External API for authenticated Vings financial data. When the credential
    owner belongs to a two-member household, financial reads cover both members.
    Transaction writes stay on the connecting member. REST routes are read-only.
    MCP also exposes opted-in write tools for transactions and budgets.
    Membership changes stay in the Vings app.
servers:
  - url: https://external.vin.gs/api
    description: Production
security: []
tags:
  - name: Transactions
    description: Transaction search and recurring payments
  - name: Cashflow
    description: Cashflow summaries
  - name: Spending
    description: Spending aggregates and merchants
  - name: Budgets
    description: Budget categories and summaries
  - name: Banks
    description: Connected bank status
  - name: Portfolio
    description: Portfolio snapshots and history
  - name: Preferences
    description: User preferences
  - name: OAuth
    description: OAuth protected-resource metadata (RFC 9728)
  - name: Health
    description: Liveness and readiness
  - name: User
    description: Authenticated user
  - name: Household
    description: >-
      Read-only household context. Joining, leaving, and credential approval
      stay in the Vings app.
  - name: MCP
    description: Model Context Protocol JSON-RPC transport
paths:
  /v1/household:
    get:
      tags:
        - Household
      responses:
        '200':
          description: >-
            Read-only household context for this credential. Membership changes
            stay in the Vings app.
          content:
            application/json:
              schema:
                type: object
                properties:
                  scope:
                    type: string
                    enum:
                      - personal
                      - household
                    description: >-
                      personal is this credential owner's own rows. household
                      includes every member when the credential owner belongs to
                      a two-member household. Joining is the consent; a second
                      credential approval is not required.
                  household_id:
                    type: string
                    nullable: true
                    format: uuid
                  membership_version:
                    type: integer
                  reporting_currency:
                    type: string
                    nullable: true
                  member_count:
                    type: integer
                  integration_approved:
                    type: boolean
                  consent:
                    type: string
                    enum:
                      - not_required
                      - required
                      - approved
                  members:
                    type: array
                    items:
                      type: object
                      properties:
                        user_id:
                          type: string
                          format: uuid
                        is_self:
                          type: boolean
                      required:
                        - user_id
                        - is_self
                required:
                  - scope
                  - household_id
                  - membership_version
                  - reporting_currency
                  - member_count
                  - integration_approved
                  - consent
                  - members
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid bearer token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: UNAUTHORIZED
            message:
              type: string
              example: Missing bearer token
            details:
              nullable: true
            requestId:
              type: string
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Vings OAuth access token or personal access token (`vng_pat_…`). Use
        `Authorization: Bearer …`.

````

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