---
title: "HouseholdMembership (People)"
description: "A household membership is the linking record between a household and a person."
---

> Documentation Index
> Fetch the complete documentation index at: https://planningcenterkit.mackenly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# HouseholdMembership (People)

A household membership is the linking record between a household and a person.

| Property | Value |
| --- | --- |
| Product | [People](/reference/people/) (`pco.people`, API version `2026-10-05`) |
| Resource type | `HouseholdMembership` |
| TypeScript | `People.HouseholdMembership`, attributes `People.HouseholdMembershipAttributes`, schema `People.HouseholdMembershipSchema` |
| Planning Center path | `/people/v2/households/{household_id}/household_memberships` |
| Planning Center docs | [HouseholdMembership](https://api.planningcenteronline.com/docs/apps/people/versions/2026-10-05/vertices/household_membership) |

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.people.households.id(householdId).household_memberships` | Collection |  | Yes |
| `pco.people.people.id(personId).household_memberships` | Collection |  | No |

From a collection, `.id(householdMembershipId)` addresses one HouseholdMembership: `pco.people.households.id(householdId).household_memberships.id(householdMembershipId)`. Collections support [`where`, `include`, `order`, and pagination](/guides/querying/); single resources have `get()`.

## Attributes

On `People.HouseholdMembershipAttributes`. Every resource also has `id` and `type` (`'HouseholdMembership'`) next to its attributes.

| Name | Type | Description |
| --- | --- | --- |
| `household_role` | `string \| null` | The role of the person within the household. Possible values are: `adult`, `child_or_dependent`, `other_adult`or`parent_guardian`. |
| `pending` | `boolean \| null` | False when a person's membership in a household is unverified. |
| `person_name` | `string \| null` |  |

## Relationships and includes

Side-load with `include()` (or `get({ include })`) and read with `related(resource, name)`: `household`, `person`.

| Relationship | Type | To | Includable |
| --- | --- | --- | --- |
| `person` | To one | [Person](/reference/people/person/) | Yes |

## Querying

### Where

`where(field, value)` for equality; `where(field, op, value)` with the operators listed.

| Field | Value type | Operators |
| --- | --- | --- |
| `pending` | `boolean` | Equality only |
| `person_name` | `string` | Equality only |

### Order

`order(...)` accepts these fields, ascending, or descending with a `-` prefix: `pending`, `person_name`.

## Edges

Follow these from one HouseholdMembership, `ref = pco.people.households.id(householdId).household_memberships.id(householdMembershipId)`:

| Edge | Leads to | Returns | Filters | Create |
| --- | --- | --- | --- | --- |
| `ref.household` | [Household](/reference/people/household/) | Collection |  | No |
| `ref.person` | [Person](/reference/people/person/) | Collection |  | No |

## Writing

| Property | Value |
| --- | --- |
| Create | Yes, `create()` on `household_memberships` on [Household](/reference/people/household/) |
| Update | Yes, `update()` on a reference |
| Delete | Yes, `delete()` on a reference |

### Create attributes

Typed as `People.HouseholdMembershipSchema['create']`.

| Attribute | Type |
| --- | --- |
| `household_role` | `string \| null` |
| `pending` | `boolean \| null` |
| `person_id` | `string` |

### Update attributes

Typed as `People.HouseholdMembershipSchema['update']`.

| Attribute | Type |
| --- | --- |
| `household_role` | `string \| null` |
| `pending` | `boolean \| null` |
| `person_id` | `string` |

See [Writing data](/guides/writing-data/).

## Example

```ts
import type { People } from '@mackenly/planningcenterkit';

const householdId = '1'; // Household id

const page = await pco.people.households.id(householdId).household_memberships.order('pending').perPage(25).list();
const items: People.HouseholdMembership[] = page.data;
```

Source: https://planningcenterkit.mackenly.com/reference/people/household-membership/index.mdx
