Skip to content

Membership (Groups)

The state of a Person belonging to a Group.

The state of a Person belonging to a Group.

A Person can only have one active Membership to a Group at a time.

Property Value
Product Groups (pco.groups, API version 2026-11-10)
Resource type Membership
TypeScript Groups.Membership, attributes Groups.MembershipAttributes, schema Groups.MembershipSchema
Planning Center path /groups/v2/memberships
Planning Center docs Membership

How to reach it

Client path Returns Filters Create
pco.groups.memberships Collection group, leader, person No
pco.groups.groups.id(groupId).memberships Collection Yes
pco.groups.groups.id(groupId).my_membership Collection No
pco.groups.people.id(personId).memberships Collection No

From a collection, .id(membershipId) addresses one Membership: pco.groups.memberships.id(membershipId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Groups.MembershipAttributes. Every resource also has id and type ('Membership') next to its attributes.

Name Type Description
joined_at string | null The date and time the person joined the group.
role string | null The role of the person in the group. Possible values: member or leader

Relationships and includes

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

Relationship Type To Includable
group To one Group Yes
person To one Person Yes

Querying

Where

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

Field Value type Operators
role string Equality only

Order

order(...) accepts these fields, ascending, or descending with a - prefix: first_name, joined_at, last_name, role.

Filters

filter(...) names depend on the edge you query through:

Edge Filters
pco.groups.memberships group, leader, person

Edges

Follow these from one Membership, ref = pco.groups.memberships.id(membershipId):

Edge Leads to Returns Filters Create
ref.group Group Collection No
ref.person Person Collection No

Writing

Property Value
Create Yes, create() on memberships on Group
Update Yes, update() on a reference
Delete Yes, delete() on a reference

Create attributes

Typed as Groups.MembershipSchema['create'].

Attribute Type
joined_at string | null
person_id string
role string | null

Update attributes

Typed as Groups.MembershipSchema['update'].

Attribute Type
joined_at string | null
role string | null

See Writing data.

Example

import type { Groups } from '@mackenly/planningcenterkit';

const page = await pco.groups.memberships.order('first_name').perPage(25).list();
const items: Groups.Membership[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close