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

# Quickstart

> Get oriented with HouseholdOS as an integrator or contributor.

# Quickstart

## What is HouseholdOS?

HouseholdOS is a web application for household operations: tasks, chores, calendars, budgets and secure bank linking, bills, receipts and taxes, room-based inventory and floor plans, meal planning, goals, activity feeds, and administration. It is not a Shopify app.

## Sign-in model

HouseholdOS uses hosted identity management for browser sign-in. The primary flow establishes a same-origin application session, and supported non-browser credentials can authorize API requests. The read-only calendar subscription is the exception: its unguessable URL grants access without an application session, so keep the complete URL private.

Public integration points:

* HTTP API at `app.householdos.pndsvcs.com` (see the HTTP route inventory for all routes)
* Stripe Financial Connections for bank account linking
* Google Calendar one-way push sync
* Apple Calendar / ICS subscription feed
* Transactional email and SMS endpoints

## Local setup

Local environment configuration and deployment instructions are intentionally omitted from this public guide.

## Common commands

Build, verification, migration, and deployment commands are intentionally omitted from this public guide.

## API reference

The HTTP route inventory documents every route dispatched by the application service in this source snapshot. There is no OpenAPI document or SDK. Key resource groups include:

* **Household management**: create, update, list households; manage memberships
* **Invitations**: create, preview, redeem, revoke
* **Household data**: read, write, export, and import authorized household and user records
* **Notifications**: list, read, clear, email, SMS
* **Calendar integrations**: Google Calendar sync, Apple ICS feed management
* **Stripe Financial Connections**: link bank accounts, list accounts and transactions
* **Files**: upload and download authorized files
* **AI**: send prompts to the configured response service

## Data isolation

HouseholdOS stores operational data in a relational data store. Data-layer access controls isolate household records. The application also checks active household membership, assigned role, and any custom permissions before each protected operation.


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