Skip to content

Person (Current)

The Person resource in Planning Center Current: how to reach it, its attributes, and what you can query and write.

Property Value
Product Current (pco.current, API version 2018-08-01)
Resource type Person
TypeScript Current.Person, attributes Current.PersonAttributes, schema Current.PersonSchema
Planning Center path /current/v2/people
Planning Center docs Person

How to reach it

Client path Returns Filters Create
pco.current.people Collection No

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

Attributes

On Current.PersonAttributes. Every resource also has id and type ('Person') next to its attributes.

Name Type Description
email string | null
first_name string | null
last_name string | null

Relationships and includes

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

Querying

No documented where fields.

No documented order fields.

Edges

Follow these from one Person, ref = pco.current.people.id(personId):

Edge Leads to Returns Filters Create
ref.organization Organization Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

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

const page = await pco.current.people.perPage(25).list();
const items: Current.Person[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close