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

# Create household

> Creates a household. Requires the `households:write` permission.



## OpenAPI

````yaml /openapi.json post /api/v1/households
openapi: 3.0.3
info:
  title: Headlight API
  version: 1.0.0
  description: >-
    Initial public reference for a small subset of Headlight HTTP APIs. This
    document is maintained alongside the application; expand coverage only after
    verifying each operation against the live codebase. The in-browser API
    playground may not work from the docs domain without additional cross-origin
    configuration.
servers:
  - url: https://app.withheadlight.com
    description: Production
security: []
paths:
  /api/v1/households:
    post:
      tags:
        - Households
      summary: Create household
      description: Creates a household. Requires the `households:write` permission.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateHouseholdRequest'
      responses:
        '201':
          description: Household created
          content:
            application/json:
              schema:
                type: object
                properties:
                  household:
                    $ref: '#/components/schemas/HouseholdCreated'
                required:
                  - household
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimit'
      security:
        - BearerAuth: []
        - SessionAuth: []
components:
  schemas:
    CreateHouseholdRequest:
      type: object
      required:
        - name
      properties:
        name:
          type: string
          minLength: 1
        dsueReceived:
          type: number
          nullable: true
        deceasedSpouseName:
          type: string
          nullable: true
        dsueDateOfDeath:
          type: string
          format: date
          nullable: true
        metadata:
          type: object
          additionalProperties: true
        primaryClient:
          $ref: '#/components/schemas/InlineClient'
        coClient:
          $ref: '#/components/schemas/InlineClient'
        primaryClientAsDonor:
          type: boolean
        coClientAsDonor:
          type: boolean
    HouseholdCreated:
      type: object
      description: Created household; full shape matches the service response.
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - name
    InlineClient:
      type: object
      required:
        - firstName
        - lastName
      properties:
        firstName:
          type: string
          minLength: 1
        lastName:
          type: string
          minLength: 1
        city:
          type: string
        state:
          type: string
    ErrorBody:
      type: object
      properties:
        error:
          type: string
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
    RateLimit:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              resetAt:
                type: string
                format: date-time
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'API key authentication. Use `Authorization: Bearer idx_...`.'
    SessionAuth:
      type: apiKey
      in: cookie
      name: wos-session
      description: WorkOS session cookie from the Headlight web app.

````