A rule belongs to a List and groups conditions together.
| Property | Value |
|---|---|
| Product | People (pco.people, API version 2026-10-05) |
| Resource type | Rule |
| TypeScript | People.Rule, attributes People.RuleAttributes, schema People.RuleSchema |
| Planning Center path | /people/v2/lists/{list_id}/rules |
| Planning Center docs | Rule |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.people.lists.id(listId).rules |
Collection | No |
From a collection, .id(ruleId) addresses one Rule: pco.people.lists.id(listId).rules.id(ruleId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On People.RuleAttributes. Every resource also has id and type ('Rule') next to its attributes.
| Name | Type | Description |
|---|---|---|
created_at |
string | null |
|
subset |
string | null |
|
updated_at |
string | null |
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): conditions.
Querying
Where
where(field, value) for equality; where(field, op, value) with the operators listed.
| Field | Value type | Operators |
|---|---|---|
created_at |
string | Date |
gt, gte, lt, lte |
subset |
string |
Equality only |
updated_at |
string | Date |
gt, gte, lt, lte |
Order
order(...) accepts these fields, ascending, or descending with a - prefix: created_at, subset, updated_at.
Edges
Follow these from one Rule, ref = pco.people.lists.id(listId).rules.id(ruleId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.conditions |
Condition | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { People } from '@mackenly/planningcenterkit';
const listId = '1'; // List id
const page = await pco.people.lists.id(listId).rules.order('created_at').perPage(25).list();
const items: People.Rule[] = page.data;