> ## 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.

# List households

> Returns a paginated list of households for the authenticated organization. Requires the `households:read` permission on the API key or session.



## OpenAPI

````yaml /openapi.json get /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:
    get:
      tags:
        - Households
      summary: List households
      description: >-
        Returns a paginated list of households for the authenticated
        organization. Requires the `households:read` permission on the API key
        or session.
      parameters:
        - name: search
          in: query
          schema:
            type: string
          description: Search households by name or related text.
        - name: page
          in: query
          schema:
            type: integer
            minimum: 1
          description: Page number (1-based).
        - name: pageSize
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 1000
          description: Page size.
        - name: sortBy
          in: query
          schema:
            type: string
            enum:
              - name
              - members
              - createdAt
          description: Sort column.
        - name: sortOrder
          in: query
          schema:
            type: string
            enum:
              - asc
              - desc
          description: Sort direction.
        - name: excludeSample
          in: query
          schema:
            type: boolean
          description: When `true`, excludes sample households.
        - name: isSample
          in: query
          schema:
            type: boolean
          description: When `true`, returns only sample households.
        - name: ids
          in: query
          schema:
            type: string
          description: >-
            Filter by household UUIDs. Use repeated `ids` query keys and/or
            comma-separated values.
      responses:
        '200':
          description: Paginated households
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HouseholdListResponse'
        '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:
    HouseholdListResponse:
      type: object
      properties:
        households:
          type: array
          maxItems: 1000
          items:
            $ref: '#/components/schemas/HouseholdSummary'
        total:
          type: integer
        page:
          type: integer
        pageSize:
          type: integer
      required:
        - households
        - total
        - page
        - pageSize
    HouseholdSummary:
      type: object
      description: >-
        List item shape includes members, assignments, and counts; this schema
        is abbreviated for docs.
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - name
    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.

````