Skip to content

PersonApp (People)

A Person App is the relationship between a Person and an App.

A Person App is the relationship between a Person and an App.

Property Value
Product People (pco.people, API version 2026-10-05)
Resource type PersonApp
TypeScript People.PersonApp, attributes People.PersonAppAttributes, schema People.PersonAppSchema
Planning Center path /people/v2/people/{person_id}/person_apps
Planning Center docs PersonApp

How to reach it

Client path Returns Filters Create
pco.people.people.id(personId).person_apps Collection Yes

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

Attributes

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

Name Type Description
allow_pco_login boolean | null
people_permissions string | null Possible values: no_access, viewer, or editor

Relationships and includes

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

Relationship Type To Includable
app To one App Yes
person To one Person No

Querying

No documented where fields.

No documented order fields.

Edges

Follow these from one PersonApp, ref = pco.people.people.id(personId).person_apps.id(personAppId):

Edge Leads to Returns Filters Create
ref.app App Collection No

Writing

Property Value
Create Yes, create() on person_apps on Person
Update No
Delete No

Create attributes

Typed as People.PersonAppSchema['create'].

Attribute Type
app_id string
app_name unknown
email_template_id string

See Writing data.

Example

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

const personId = '1'; // Person id

const page = await pco.people.people.id(personId).person_apps.perPage(25).list();
const items: People.PersonApp[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close