---
title: "PlanNote (Services)"
description: "A specific plan note within a single plan."
---

> Documentation Index
> Fetch the complete documentation index at: https://planningcenterkit.mackenly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# PlanNote (Services)

A specific plan note within a single plan.

| Property | Value |
| --- | --- |
| Product | [Services](/reference/services/) (`pco.services`, API version `2018-11-01`) |
| Resource type | `PlanNote` |
| TypeScript | `Services.PlanNote`, attributes `Services.PlanNoteAttributes`, schema `Services.PlanNoteSchema` |
| Planning Center path | `/services/v2/service_types/{service_type_id}/plan_templates/{plan_template_id}/notes` |
| Planning Center docs | [PlanNote](https://api.planningcenteronline.com/docs/apps/services/versions/2018-11-01/vertices/plan_note) |

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.services.series.id(seriesId).plans.id(planId).notes` | Collection | `team` | Yes |
| `pco.services.service_types.id(serviceTypeId).plan_templates.id(planTemplateId).notes` | Collection |  | Yes |

From a collection, `.id(planNoteId)` addresses one PlanNote: `pco.services.series.id(seriesId).plans.id(planId).notes.id(planNoteId)`. Collections support [`where`, `include`, `order`, and pagination](/guides/querying/); single resources have `get()`.

## Attributes

On `Services.PlanNoteAttributes`. Every resource also has `id` and `type` (`'PlanNote'`) next to its attributes.

| Name | Type | Description |
| --- | --- | --- |
| `category_name` | `string \| null` |  |
| `content` | `string \| null` |  |
| `created_at` | `string \| null` |  |
| `updated_at` | `string \| null` |  |

## Relationships and includes

Side-load with `include()` (or `get({ include })`) and read with `related(resource, name)`: `plan_note_category`.

| Relationship | Type | To | Includable |
| --- | --- | --- | --- |
| `created_by` | To one | [Person](/reference/services/person/) | No |
| `plan_note_category` | To one | [PlanNoteCategory](/reference/services/plan-note-category/) | Yes |
| `teams` | To one | [Team](/reference/services/team/) | 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` |
| `updated_at` | `string \| Date` | `gt`, `gte`, `lt`, `lte` |

### Order

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

### Filters

`filter(...)` names depend on the edge you query through:

| Edge | Filters |
| --- | --- |
| `notes` on [Plan](/reference/services/plan/) | `team` |

## Edges

Follow these from one PlanNote, `ref = pco.services.series.id(seriesId).plans.id(planId).notes.id(planNoteId)`:

| Edge | Leads to | Returns | Filters | Create |
| --- | --- | --- | --- | --- |
| `ref.plan_note_category` | [PlanNoteCategory](/reference/services/plan-note-category/) | Collection |  | No |

## Writing

| Property | Value |
| --- | --- |
| Create | Yes, `create()` on `notes` on [Plan](/reference/services/plan/), `notes` on [PlanTemplate](/reference/services/plan-template/) |
| Update | Yes, `update()` on a reference |
| Delete | Yes, `delete()` on a reference |

### Create attributes

Typed as `Services.PlanNoteSchema['create']`.

| Attribute | Type |
| --- | --- |
| `content` | `string \| null` |
| `plan_note_category_id` | `string` |
| `team_ids` | `string[]` |

### Update attributes

Typed as `Services.PlanNoteSchema['update']`.

| Attribute | Type |
| --- | --- |
| `content` | `string \| null` |
| `plan_note_category_id` | `string` |
| `team_ids` | `string[]` |

See [Writing data](/guides/writing-data/).

## Example

```ts
import type { Services } from '@mackenly/planningcenterkit';

const seriesId = '1'; // Series id
const planId = '1'; // Plan id

const page = await pco.services.series.id(seriesId).plans.id(planId).notes.order('created_at').perPage(25).list();
const items: Services.PlanNote[] = page.data;
```

Source: https://planningcenterkit.mackenly.com/reference/services/plan-note/index.mdx
