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