---
title: "List all households"
method: GET
path: "/v1/households"
tags: ["Households"]
---

# List all households

`GET /v1/households`

## Request

- Base URL: `https://api.slant.app`
- URL: `https://api.slant.app/v1/households`
- Auth: HTTP bearer

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

## Query parameters

- `book_id` string
- `household_type` 'client' | 'prospect' | 'past_client'
- `type` 'client' | 'prospect' | 'past_client'
- `updated_since` string
- `email` string
- `phone` string
- `name` string
- `page` integer
- `per_page` integer

## Response `200`

successful

- object
  - `data` Household[], required
    - `id` string, required: The ID of the household
    - `type` 'Client' | 'Prospect' | 'PastClient', required: The type of household
    - `name` string, required: The name of the household
    - `tier` string, nullable: The tier label for this household (null for Prospects)
    - `became_client_at` string, date-time, nullable: When this household became a client (null for Prospects)
    - `book_id` string, required: The ID of the book this household belongs to
    - `profile_picture_url` string, uri, nullable: URL to the household profile picture
    - `custom_fields` object: Custom field values as key-value pairs
    - `people` Person[], required: The people in this household
      - `id` string, required: The person ID
      - `book_id` string, required: The book ID
      - `household_id` string, nullable: The household ID
      - `contact_id` string, nullable: The contact ID (present when person belongs to a contact)
      - `role_type` 'client' | 'prospect' | 'contact' | 'past_client', nullable: The entity type this person belongs to
      - `created_at` string, date-time, required: When the person was created
      - `updated_at` string, date-time, required: When the person record was last updated. Associated record changes do not advance this timestamp.
      - `first_name` string, required
      - `middle_name` string, nullable
      - `last_name` string, required
      - `salutation` string, nullable
      - `suffix` string, nullable
      - `maiden_name` string, nullable
      - `gender` 'female' | 'male' | 'nonbinary' | 'other' | 'prefer_not_to_say', nullable
      - `designations` string, nullable
      - `household_role` 'head_of_household' | 'partner' | 'spouse' | 'dependent_child' | 'other_adult' | 'other_dependent' | 'unknown' | 'deceased' | 'non_dependent_child' | 'grandchild', nullable: Only present when person belongs to a household
      - `preferred_name` string, nullable
      - `date_of_birth` string, date, nullable: Date of birth
      - `date_of_death` string, date, nullable: Date of death
      - `job_title` string, nullable: Job title
      - `ssn` string, nullable: Obfuscated social security number
      - `drivers_license_number` string, nullable: Obfuscated driver's license number
      - `email_addresses` Email[]: Array of email addresses with primary designation
        - `email` string, email, required
        - `email_type` 'personal' | 'business' | 'school' | 'other' | 'inactive', required
        - `is_primary` boolean, required
        - `id` string: The email address ID
      - `phone_numbers` PhoneNumber[]: Array of phone numbers with primary designation
        - `phone_number` string, required
        - `extension` string, nullable
        - `phone_type` 'mobile' | 'work' | 'home' | 'fax' | 'other', required
        - `is_primary` boolean, required
        - `id` string: The phone number ID
      - `addresses` Address[]: Array of addresses with primary designation
        - `line1` string, nullable
        - `line2` string, nullable
        - `city` string, nullable
        - `state` string, nullable
        - `zip` string, nullable
        - `country_code` string, nullable
        - `address_type` 'home' | 'work' | 'mailing' | 'other', required
        - `is_primary` boolean, required
        - `id` string: The address ID
      - `employments` Employment[]: Included for contacts; otherwise retrieve employment history through GET /v1/people/{person_id}/employments.
        - `id` string: The employment ID
        - `person_id` string: The person ID
        - `business_id` string, nullable: Linked employer Business ID, when available
        - `business_name` string, required
        - `role` string, nullable
        - `start_date` string, date, nullable
        - `end_date` string, date, nullable
        - `actively_employed` boolean
      - `custom_fields` object: Custom field values as key-value pairs
    - `tags` object[]
      - `id` string
      - `name` string
  - `pagination` object, required
    - `current_page` integer
    - `total_pages` integer
    - `total_count` integer
    - `per_page` integer

## Other responses

- `400`: Bad Request - malformed JSON, invalid filters, or missing required book context
- `401`: unauthorized - missing or invalid token
- `403`: Access denied. Policy and membership failures may have an empty body. A read-only personal token cannot perform writes.
- `429`: An hourly API rate limit was exceeded. Wait Retry-After seconds before retrying.

## Changes

- **2026-11-03** `173c41bf6be9`: 2 warning, 12 info
  - added the new `PastClient` enum value to the `data/items/type` response property for the response status `200`
  - added the new `inactive` enum value to the `data/items/people/items/email_addresses/items/email_type` response property for the response status `200`
  - added the media type `application/json` for the response with the status `403`
  - added the non-success response with the status `429`
  - …10 more

[Operation history](https://skmtc.dev/slant/apis/slant-public-api-v1/changes/v1/households/get.md)

---

[API](https://skmtc.dev/slant/apis/slant-public-api-v1.md) - [All operations](https://skmtc.dev/slant/apis/slant-public-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/slant/apis/slant-public-api-v1/revisions/173c41bf6be9?raw)