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

# List all households

> List all households (Clients and Prospects). Supports filtering by book id, household type, updated_since timestamp, email, and phone.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/households
openapi: 3.0.1
info:
  title: Slant Public API V1
  version: v1
  description: Public API for creating and managing resources in Slant
  contact:
    name: Slant API Support
    email: api@slant.com
servers:
  - url: https://api.slant.app
security:
  - bearer: []
paths:
  /v1/households:
    get:
      tags:
        - Households
      summary: List all households
      description: >-
        List all households (Clients and Prospects). Supports filtering by book
        id, household type, updated_since timestamp, email, and phone.
      parameters:
        - name: book_id
          in: query
          required: false
          description: Filter by book ID to scope to a specific book
          example: abc123xyz
          schema:
            type: string
        - name: household_type
          in: query
          required: false
          description: Filter by household type
          example: client
          schema:
            type: string
            enum:
              - client
              - prospect
              - past_client
        - name: type
          in: query
          required: false
          description: Alias for household_type
          example: client
          schema:
            type: string
            enum:
              - client
              - prospect
              - past_client
        - name: updated_since
          in: query
          required: false
          description: Filter households updated since this ISO8601 timestamp
          example: '2024-01-01T00:00:00Z'
          schema:
            type: string
        - name: email
          in: query
          description: Filter by exact email match after normalization
          required: false
          example: john@example.com
          schema:
            type: string
        - name: phone
          in: query
          description: Filter by exact phone match (E.164 format)
          required: false
          example: '+15551234567'
          schema:
            type: string
        - name: name
          in: query
          description: >-
            Filter by person name (prefix/full-text match, not arbitrary
            substring)
          required: false
          example: John
          schema:
            type: string
        - name: page
          in: query
          required: false
          description: Page number
          schema:
            type: integer
        - name: per_page
          in: query
          required: false
          description: Items per page (max 100)
          schema:
            type: integer
      responses:
        '200':
          description: successful
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - pagination
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Household'
                  pagination:
                    type: object
                    properties:
                      current_page:
                        type: integer
                        example: 1
                      total_pages:
                        type: integer
                        example: 10
                      total_count:
                        type: integer
                        example: 100
                      per_page:
                        type: integer
                        example: 25
        '400':
          description: bad request - invalid JSON
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                  - detail
                properties:
                  error:
                    type: string
                    description: Error code
                    enum:
                      - invalid_json
                  detail:
                    oneOf:
                      - type: string
                        description: Human-readable error description
                      - type: array
                        items:
                          type: string
                        description: Array of validation error messages
        '401':
          description: unauthorized - missing or invalid token
          content:
            application/json:
              schema:
                type: object
                required:
                  - error
                  - detail
                properties:
                  error:
                    type: string
                    description: Error code
                    enum:
                      - token_missing
                      - token_invalid
                  detail:
                    oneOf:
                      - type: string
                        description: Human-readable error description
                      - type: array
                        items:
                          type: string
                        description: Array of validation error messages
        '403':
          description: forbidden
      security:
        - bearer: []
components:
  schemas:
    Household:
      type: object
      required:
        - id
        - type
        - name
        - book_id
        - people
      properties:
        id:
          type: string
          description: The ID of the household
          example: abc123xyz
        type:
          type: string
          enum:
            - Client
            - Prospect
          description: The type of household
          example: Client
        name:
          type: string
          description: The name of the household
          example: The Smith Family
        tier:
          type: string
          description: The tier label for this household (null for Prospects)
          example: Platinum
          nullable: true
        became_client_at:
          type: string
          format: date-time
          description: When this household became a client (null for Prospects)
          example: '2024-01-01T00:00:00Z'
          nullable: true
        book_id:
          type: string
          description: The ID of the book this household belongs to
          example: book123xyz
        profile_picture_url:
          type: string
          format: uri
          description: URL to the household profile picture
          example: https://api.example.com/v1/households/abc123xyz/avatar
          nullable: true
        custom_fields:
          type: object
          description: Custom field values as key-value pairs
          example:
            pageport_lead_source: Landing Page
            industry: Technology
        people:
          type: array
          items:
            $ref: '#/components/schemas/Person'
          description: The people in this household
    Person:
      type: object
      required:
        - id
        - book_id
        - first_name
        - last_name
      properties:
        id:
          type: string
          description: The person ID
          example: abc123xyz
        book_id:
          type: string
          description: The book ID
          example: book123xyz
        household_id:
          type: string
          description: The household ID
          example: xyz789abc
          nullable: true
        contact_id:
          type: string
          description: The contact ID (present when person belongs to a contact)
          example: cnt456def
          nullable: true
        role_type:
          type: string
          enum:
            - client
            - prospect
            - contact
            - past_client
          description: The entity type this person belongs to
          example: client
          nullable: true
        first_name:
          type: string
          example: John
        middle_name:
          type: string
          example: Robert
          nullable: true
        last_name:
          type: string
          example: Doe
        salutation:
          type: string
          example: Mr.
          nullable: true
        suffix:
          type: string
          example: Jr.
          nullable: true
        maiden_name:
          type: string
          example: Smith
          nullable: true
        gender:
          type: string
          enum:
            - female
            - male
            - nonbinary
            - other
            - prefer_not_to_say
          example: male
          nullable: true
        designations:
          type: string
          example: CPA, CFP
          nullable: true
        household_role:
          type: string
          enum:
            - head_of_household
            - partner
            - spouse
            - dependent_child
            - other_adult
            - other_dependent
            - unknown
            - deceased
            - non_dependent_child
            - grandchild
          example: head_of_household
          nullable: true
          description: Only present when person belongs to a household
        preferred_name:
          type: string
          example: Johnny
          nullable: true
        date_of_birth:
          type: string
          format: date
          description: Date of birth
          example: '1985-06-15'
          nullable: true
        job_title:
          type: string
          description: Job title
          example: Software Engineer
          nullable: true
        ssn:
          type: string
          description: Obfuscated social security number
          example: '***-**-6789'
          nullable: true
        drivers_license_number:
          type: string
          description: Obfuscated driver's license number
          example: '******7890'
          nullable: true
        email_addresses:
          type: array
          items:
            $ref: '#/components/schemas/Email'
          description: Array of email addresses with primary designation
        phone_numbers:
          type: array
          items:
            $ref: '#/components/schemas/PhoneNumber'
          description: Array of phone numbers with primary designation
        addresses:
          type: array
          items:
            $ref: '#/components/schemas/Address'
          description: Array of addresses with primary designation
        employments:
          type: array
          items:
            $ref: '#/components/schemas/Employment'
          description: Array of employment records
        custom_fields:
          type: object
          description: Custom field values as key-value pairs
          example:
            preferred_contact_method: Email
            risk_tolerance: Moderate
    Email:
      type: object
      required:
        - email
        - email_type
        - is_primary
      properties:
        email:
          type: string
          format: email
          example: john.doe@example.com
        email_type:
          type: string
          enum:
            - personal
            - business
            - school
            - other
          example: personal
        is_primary:
          type: boolean
          example: true
    PhoneNumber:
      type: object
      required:
        - phone_number
        - phone_type
        - is_primary
      properties:
        phone_number:
          type: string
          example: '+15555551234'
        extension:
          type: string
          nullable: true
          example: '1234'
        phone_type:
          type: string
          enum:
            - mobile
            - work
            - home
            - fax
            - other
          example: mobile
        is_primary:
          type: boolean
          example: true
    Address:
      type: object
      required:
        - address_type
        - is_primary
      properties:
        line1:
          type: string
          example: 123 Main St
          nullable: true
        line2:
          type: string
          example: Apt 4B
          nullable: true
        city:
          type: string
          example: New York
          nullable: true
        state:
          type: string
          example: NY
          nullable: true
        zip:
          type: string
          example: '10001'
          nullable: true
        country_code:
          type: string
          example: US
          nullable: true
        address_type:
          type: string
          enum:
            - home
            - work
            - mailing
            - other
          example: home
        is_primary:
          type: boolean
          example: true
    Employment:
      type: object
      required:
        - business_name
      properties:
        id:
          type: string
          description: The employment ID
          example: emp123xyz
        person_id:
          type: string
          description: The person ID
          example: abc123xyz
        business_name:
          type: string
          example: Acme Corp
        role:
          type: string
          example: Software Engineer
          nullable: true
        start_date:
          type: string
          format: date
          example: '2023-01-15'
          nullable: true
        end_date:
          type: string
          format: date
          example: '2024-12-31'
          nullable: true
        actively_employed:
          type: boolean
          example: true
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: OAuth
      description: OAuth 2.0 Bearer Token from Clerk authentication

````