Skip to content

PlatformNotification (People)

A Platform Notification is a suite-wide notification that shows at the top of each application's screen until dismissed by the user.

A Platform Notification is a suite-wide notification that shows at the top of each application’s screen until dismissed by the user.

Property Value
Product People (pco.people, API version 2026-10-05)
Resource type PlatformNotification
TypeScript People.PlatformNotification, attributes People.PlatformNotificationAttributes, schema People.PlatformNotificationSchema
Planning Center path /people/v2/people/{person_id}/platform_notifications
Planning Center docs PlatformNotification

How to reach it

Client path Returns Filters Create
pco.people.people.id(personId).platform_notifications Collection No

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

Attributes

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

Name Type Description
html string | null

Querying

No documented where fields.

No documented order fields.

Edges

This resource has no documented edges.

Writing

Property Value
Create No
Update No
Delete No

Example

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

const personId = '1'; // Person id

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

Type to search…

↑↓ navigate↵ selectEsc close