A Note Category
| Property | Value |
|---|---|
| Product | People (pco.people, API version 2026-10-05) |
| Resource type | NoteCategory |
| TypeScript | People.NoteCategory, attributes People.NoteCategoryAttributes, schema People.NoteCategorySchema |
| Planning Center path | /people/v2/note_categories |
| Planning Center docs | NoteCategory |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.people.note_categories |
Collection | view_creatable |
Yes |
pco.people.notes.id(noteId).category |
Collection | No |
From a collection, .id(noteCategoryId) addresses one NoteCategory: pco.people.note_categories.id(noteCategoryId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On People.NoteCategoryAttributes. Every resource also has id and type ('NoteCategory') next to its attributes.
| Name | Type | Description |
|---|---|---|
created_at |
string | null |
|
locked |
boolean | null |
|
name |
string | null |
|
organization_id |
number | null |
|
updated_at |
string | null |
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): shares, subscribers, subscriptions.
| Relationship | Type | To | Includable |
|---|---|---|---|
organization |
To one | Organization | No |
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 |
locked |
boolean |
Equality only |
name |
string |
Equality only |
organization_id |
string | number |
Equality only |
updated_at |
string | Date |
gt, gte, lt, lte |
Order
order(...) accepts these fields, ascending, or descending with a - prefix: created_at, locked, name, organization_id, updated_at.
Filters
filter(...) names depend on the edge you query through:
| Edge | Filters |
|---|---|
pco.people.note_categories |
view_creatable |
Edges
Follow these from one NoteCategory, ref = pco.people.note_categories.id(noteCategoryId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.shares |
NoteCategoryShare | Collection | Yes | |
ref.subscribers |
Person | Collection | No | |
ref.subscriptions |
NoteCategorySubscription | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | Yes, create() on pco.people.note_categories |
| Update | Yes, update() on a reference |
| Delete | Yes, delete() on a reference |
Create attributes
Typed as People.NoteCategorySchema['create'].
| Attribute | Type |
|---|---|
name |
string | null |
Update attributes
Typed as People.NoteCategorySchema['update'].
| Attribute | Type |
|---|---|
name |
string | null |
See Writing data.
Example
import type { People } from '@mackenly/planningcenterkit';
const page = await pco.people.note_categories.order('created_at').perPage(25).list();
const items: People.NoteCategory[] = page.data;