betteroff-finance

betteroff-finance Household API

The household API from betteroff-finance — 7 operation(s) for household.

GitHub OpenAPI

Operations 8

GET /household/invitations/{id} Get household invitations id #
POST /household/invitations/{id}/accept Post household invitations id accept #
GET /household/succession Get household succession #
POST /household/succession Post household succession #
GET /household Get household #
POST /household/invitations Post household invitations #
POST /household/invitations/{id}/cancel Post household invitations id cancel #
DELETE /household/members/{id} Delete household members id #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/betteroff-finance/openapi/betteroff-finance-household-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/betteroff-finance:betteroff-finance-household-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

betteroff-finance-household-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: BetterOff Household API
  version: 0.5.0+cd65185c
servers:
- url: https://api.betteroff.finance
tags:
- name: household
paths:
  /household/invitations/{id}:
    get:
      operationId: getHouseholdInvitationsId
      tags:
      - household
      security:
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Get household invitations id
      x-summary-source: derived
  /household/invitations/{id}/accept:
    post:
      operationId: postHouseholdInvitationsIdAccept
      tags:
      - household
      security:
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Post household invitations id accept
      x-summary-source: derived
  /household/succession:
    get:
      operationId: getHouseholdSuccession
      tags:
      - household
      security:
      - session: []
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Get household succession
      x-summary-source: derived
    post:
      operationId: postHouseholdSuccession
      tags:
      - household
      security:
      - session: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                token:
                  type: string
                  format: uuid
                  pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                accept:
                  type: boolean
              required:
              - token
              - accept
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Post household succession
      x-summary-source: derived
  /household:
    get:
      operationId: getHousehold
      tags:
      - household
      security:
      - session: []
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Get household
      x-summary-source: derived
  /household/invitations:
    post:
      operationId: postHouseholdInvitations
      tags:
      - household
      security:
      - session: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                email:
                  type: string
                  format: email
                  pattern: ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
                role:
                  type: string
                  enum:
                  - admin
                  - viewer
              required:
              - email
              - role
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Post household invitations
      x-summary-source: derived
  /household/invitations/{id}/cancel:
    post:
      operationId: postHouseholdInvitationsIdCancel
      tags:
      - household
      security:
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Post household invitations id cancel
      x-summary-source: derived
  /household/members/{id}:
    delete:
      operationId: deleteHouseholdMembersId
      tags:
      - household
      security:
      - session: []
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        default:
          description: Problem details
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      summary: Delete household members id
      x-summary-source: derived
components:
  schemas:
    ProblemDetails:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: object
      properties:
        type:
          type: string
          description: Always "about:blank"; branch on `code`.
        title:
          type: string
        status:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
        detail:
          type: string
        code:
          type: string
          description: Stable UPPER_SNAKE code.
        error:
          type: string
          description: Older clients' copy of `detail`.
        message:
          type: string
          description: Older clients' copy of `detail`.
        requestId:
          description: Diagnostic only; quote it to support.
          type: string
        instance:
          type: string
        details:
          type: object
          propertyNames:
            type: string
          additionalProperties: {}
      required:
      - type
      - title
      - status
      - detail
      - code
      - error
      - message
      additionalProperties: {}
      description: RFC 9457 problem details. Some refusals add fields; ignore ones you don't know.
  securitySchemes:
    session:
      type: http
      scheme: bearer
      description: 'The BetterOff app acting for its signed-in user. Not available to integrations: Better Auth session tokens and browser session cookies are rejected. Use an API token or agent OAuth.'
    apiToken:
      type: http
      scheme: bearer
      description: Personal API token (bo_pat_), created in BetterOff settings with the scopes it may use.
    agentOAuth:
      type: openIdConnect
      openIdConnectUrl: https://app.betteroff.finance/api/auth/.well-known/openid-configuration
      description: Agent OAuth grant; the same token and scopes as /mcp.