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

# List all households

`GET /v1/households`

## Query parameters

- `headContactId` string, nullable
- `contacts` string, nullable
- `query` string, nullable
- `sortBy` string, nullable
- `sortByDesc` string, nullable
- `page` string

## Response `200`

Array of `HouseholdResource`

- HouseholdResource[]
  - `id` integer, required
  - `name` string, required
  - `head_contact_id` integer, nullable, required
  - `account_id` integer, required
  - `envelope_name` string, nullable, required
  - `note` string, nullable, required
  - `created_at` string, date-time, nullable, required
  - `updated_at` string, date-time, nullable, required
  - `contacts` object[]
    - `id` string, required
    - `company_name` string, required
    - `first_name` string, required
    - `first_name_display` string, required
    - `last_name` string, required
    - `last_name_display` string, required
    - `middle_name` string, required
    - `name_display` string, required
    - `primary_email` string, required
    - `primary_phone` string, required
    - `type` string, required

## Other responses

- `422` — Validation error

---

[API](https://skmtc.net/givebutter/apis/givebutter-api-documentation.md) · [All operations](https://skmtc.net/givebutter/apis/givebutter-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/givebutter/givebutter-api-documentation/versions/b788722bbaf6/schema)