---
title: "Query for Household (householdQuery)"
method: POST
path: "/householdQuery"
---

# Query for Household (householdQuery)

`POST /householdQuery`

Used to retrieve the collection of Link IDs that have been grouped into a household.

## Request body

- ServiceRequestHouseholdQuery
  - `content` HouseholdQueryWsRequest
    - `householdId` string — The householdId to use in the query
    - `linkId` string — The link ID to use in the query
    - `source` Source — Represents the information tracking an identity to a source that contains the identity
      - `date` string — The date of the source data in ISO format (yyyy-mm-dd).
      - `name` string — The name of the data source. Must be unique across Verato.
      - `id` string — The ID of an identity within the given data source.
  - `trackingId` string

## Response `200`

OK

- ServiceResponseHouseholdQuery
  - `auditId` string
  - `success` boolean
  - `warnings` string[]
  - `retryableError` boolean
  - `message` string
  - `content` HouseholdQueryWsResponse
    - `householdId` string, required — The householdId.
    - `lastUpdateDate` string, date-time
    - `linkIdsInHousehold` string[], required — Current linkIds in the household.
    - `createDate` string, date-time
  - `errors` string[]
  - `trackingId` string

---

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