A category of plan notes for an entire Service Type.
| Property | Value |
|---|---|
| Product | Services (pco.services, API version 2018-11-01) |
| Resource type | PlanNoteCategory |
| TypeScript | Services.PlanNoteCategory, attributes Services.PlanNoteCategoryAttributes, schema Services.PlanNoteCategorySchema |
| Planning Center path | /services/v2/service_types/{service_type_id}/plan_note_categories |
| Planning Center docs | PlanNoteCategory |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.services.series.id(seriesId).plans.id(planId).notes.id(planNoteId).plan_note_category |
Collection | No | |
pco.services.service_types.id(serviceTypeId).plan_note_categories |
Collection | No |
From a collection, .id(planNoteCategoryId) addresses one PlanNoteCategory: pco.services.service_types.id(serviceTypeId).plan_note_categories.id(planNoteCategoryId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Services.PlanNoteCategoryAttributes. Every resource also has id and type ('PlanNoteCategory') next to its attributes.
| Name | Type | Description |
|---|---|---|
created_at |
string | null |
|
deleted_at |
string | null |
|
name |
string | null |
|
sequence |
number | null |
|
updated_at |
string | null |
Relationships and includes
Planning Center documents no includes for this resource.
| Relationship | Type | To | Includable |
|---|---|---|---|
service_type |
To one | ServiceType | No |
teams |
To one | Team | No |
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 { Services } from '@mackenly/planningcenterkit';
const serviceTypeId = '1'; // ServiceType id
const page = await pco.services.service_types.id(serviceTypeId).plan_note_categories.perPage(25).list();
const items: Services.PlanNoteCategory[] = page.data;