Skip to content

NoteCategorySubscription (People)

A subscription for note categories

A subscription for note categories

Property Value
Product People (pco.people, API version 2026-10-05)
Resource type NoteCategorySubscription
TypeScript People.NoteCategorySubscription, attributes People.NoteCategorySubscriptionAttributes, schema People.NoteCategorySubscriptionSchema
Planning Center path /people/v2/note_category_subscriptions
Planning Center docs NoteCategorySubscription

How to reach it

Client path Returns Filters Create
pco.people.note_category_subscriptions Collection No
pco.people.note_categories.id(noteCategoryId).subscriptions Collection No

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

Attributes

On People.NoteCategorySubscriptionAttributes. Every resource also has id and type ('NoteCategorySubscription') 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.

Relationship Type To Includable
note_category To one NoteCategory No
person To one Person Yes

Querying

Where

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

Field Value type Operators
created_at string | Date gt, gte, lt, lte
updated_at string | Date gt, gte, lt, lte

Order

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

Edges

Follow these from one NoteCategorySubscription, ref = pco.people.note_category_subscriptions.id(noteCategorySubscriptionId):

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 page = await pco.people.note_category_subscriptions.order('created_at').perPage(25).list();
const items: People.NoteCategorySubscription[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close