API
⌘K
My Developer Account

HouseholdMembership

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

Example Request

curl https://api.planningcenteronline.com/people/v2/households/{household_id}/household_memberships

View in API Explorer →

Example Object

{
  "type": "HouseholdMembership",
  "id": "1",
  "attributes": {
    "household_role": "string",
    "pending": true,
    "person_name": "string"
  },
  "relationships": {
    "person": {
      "data": {
        "type": "Person",
        "id": "1"
      }
    }
  }
}

Attributes

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

Relationships

Name Type Association Type Note
person Person to_one

Can Include

Parameter Value Description Assignable
include household include associated household
include person include associated person create and update

Order By

Parameter Value Type Description
order pending string prefix with a hyphen (-pending) to reverse the order
order person_name string prefix with a hyphen (-person_name) to reverse the order

Query By

Name Parameter Type Description Example
pending where[pending] boolean Query on a specific pending ?where[pending]=true
person_name where[person_name] string Query on a specific person_name ?where[person_name]=string

Pagination

Name Parameter Type Description
per_page per_page integer how many records to return per page (min=1, max=100, default=25)
offset offset integer get results from given offset

Endpoints

Listing

HTTP Method Endpoint
GET /people/v2/households/{household_id}/household_memberships

Reading

HTTP Method Endpoint
GET /people/v2/households/{household_id}/household_memberships/{id}

Creating

HTTP Method Endpoint Assignable Attributes
POST /people/v2/households/{household_id}/household_memberships
  • person_id
  • pending
  • household_role

Updating

HTTP Method Endpoint Assignable Attributes
PATCH /people/v2/households/{household_id}/household_memberships/{id}
  • person_id
  • pending
  • household_role

Deleting

HTTP Method Endpoint
DELETE /people/v2/households/{household_id}/household_memberships/{id}

Associations

HTTP Method Endpoint Returns Details Filter By
GET https://api.planningcenteronline.com/people/v2/households/{household_id}/household_memberships/{household_membership_id}/household Household
GET https://api.planningcenteronline.com/people/v2/households/{household_id}/household_memberships/{household_membership_id}/person Person

Belongs To

HTTP Method Endpoint Association Details Filter By
GET https://api.planningcenteronline.com/people/v2/households/{household_id}/household_memberships Household
GET https://api.planningcenteronline.com/people/v2/people/{person_id}/household_memberships Person