Skip to content

ItemNoteCategory (Services)

A category of plan item notes for an entire Service Type.

A category of plan item notes for an entire Service Type.

Property Value
Product Services (pco.services, API version 2018-11-01)
Resource type ItemNoteCategory
TypeScript Services.ItemNoteCategory, attributes Services.ItemNoteCategoryAttributes, schema Services.ItemNoteCategorySchema
Planning Center path /services/v2/service_types/{service_type_id}/item_note_categories
Planning Center docs ItemNoteCategory

How to reach it

Client path Returns Filters Create
pco.services.songs.id(songId).last_scheduled_item.id(itemId).item_notes.id(itemNoteId).item_note_category Collection No
pco.services.service_types.id(serviceTypeId).item_note_categories Collection No

From a collection, .id(itemNoteCategoryId) addresses one ItemNoteCategory: pco.services.service_types.id(serviceTypeId).item_note_categories.id(itemNoteCategoryId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Services.ItemNoteCategoryAttributes. Every resource also has id and type ('ItemNoteCategory') next to its attributes.

Name Type Description
created_at string | null
deleted_at string | null
frequently_used boolean | 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

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).item_note_categories.perPage(25).list();
const items: Services.ItemNoteCategory[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close