A list result
| Property | Value |
|---|---|
| Product | People (pco.people, API version 2026-10-05) |
| Resource type | ListResult |
| TypeScript | People.ListResult, attributes People.ListResultAttributes, schema People.ListResultSchema |
| Planning Center path | /people/v2/lists/{list_id}/list_results |
| Planning Center docs | ListResult |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.people.lists.id(listId).list_results |
Collection | No |
From a collection, .id(listResultId) addresses one ListResult: pco.people.lists.id(listId).list_results.id(listResultId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On People.ListResultAttributes. Every resource also has id and type ('ListResult') next to its attributes.
| Name | Type | Description |
|---|---|---|
created_at |
string | null |
|
updated_at |
string | null |
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): person.
Querying
Where
where(field, value) for equality; where(field, op, value) with the operators listed.
| Field | Value type | Operators |
|---|---|---|
person_id |
string | number |
Equality only |
Order
order(...) accepts these fields, ascending, or descending with a - prefix: created_at, updated_at.
Edges
Follow these from one ListResult, ref = pco.people.lists.id(listId).list_results.id(listResultId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.person |
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 page = await pco.people.lists.id(listId).list_results.order('created_at').perPage(25).list();
const items: People.ListResult[] = page.data;