Skip to content

Report (People)

A report is editable liquid syntax that provides a powerful tool for presenting your Lists however you want.

A report is editable liquid syntax that provides a powerful tool for presenting your Lists however you want.

Property Value
Product People (pco.people, API version 2026-10-05)
Resource type Report
TypeScript People.Report, attributes People.ReportAttributes, schema People.ReportSchema
Planning Center path /people/v2/reports
Planning Center docs Report

How to reach it

Client path Returns Filters Create
pco.people.reports Collection Yes

From a collection, .id(reportId) addresses one Report: pco.people.reports.id(reportId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On People.ReportAttributes. Every resource also has id and type ('Report') next to its attributes.

Name Type Description
body string | null
created_at string | null
name string | null
updated_at string | null

Relationships and includes

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

Querying

Where

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

Field Value type Operators
body string Equality only
created_at string | Date gt, gte, lt, lte
name string Equality only
updated_at string | Date gt, gte, lt, lte

Order

order(...) accepts these fields, ascending, or descending with a - prefix: body, created_at, name, updated_at.

Edges

Follow these from one Report, ref = pco.people.reports.id(reportId):

Edge Leads to Returns Filters Create
ref.created_by Person Collection No
ref.updated_by Person Collection No

Writing

Property Value
Create Yes, create() on pco.people.reports
Update Yes, update() on a reference
Delete Yes, delete() on a reference

Create attributes

Typed as People.ReportSchema['create'].

Attribute Type
body string | null
name string | null

Update attributes

Typed as People.ReportSchema['update'].

Attribute Type
body string | null
name string | null

See Writing data.

Example

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

const page = await pco.people.reports.order('body').perPage(25).list();
const items: People.Report[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close