---
title: "Note (People)"
description: "A note is text with a category connected to a person’s profile."
---

> 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.

# Note (People)

A note is text with a category connected to a person’s profile.

| Property | Value |
| --- | --- |
| Product | [People](/reference/people/) (`pco.people`, API version `2026-10-05`) |
| Resource type | `Note` |
| TypeScript | `People.Note`, attributes `People.NoteAttributes`, schema `People.NoteSchema` |
| Planning Center path | `/people/v2/notes` |
| Planning Center docs | [Note](https://api.planningcenteronline.com/docs/apps/people/versions/2026-10-05/vertices/note) |

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.people.notes` | Collection |  | No |
| `pco.people.people.id(personId).notes` | Collection |  | Yes |

From a collection, `.id(noteId)` addresses one Note: `pco.people.notes.id(noteId)`. Collections support [`where`, `include`, `order`, and pagination](/guides/querying/); single resources have `get()`.

## Attributes

On `People.NoteAttributes`. Every resource also has `id` and `type` (`'Note'`) next to its attributes.

| Name | Type | Description |
| --- | --- | --- |
| `created_at` | `string \| null` |  |
| `created_by_id` | `number \| null` |  |
| `display_date` | `string \| null` |  |
| `note` | `string \| null` |  |
| `note_category_id` | `number \| null` |  |
| `organization_id` | `number \| null` |  |
| `person_id` | `number \| null` |  |
| `updated_at` | `string \| null` |  |

## Relationships and includes

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

| Relationship | Type | To | Includable |
| --- | --- | --- | --- |
| `created_by` | To one | [Person](/reference/people/person/) | Yes |
| `note_category` | To one | [NoteCategory](/reference/people/note-category/) | No |
| `organization` | To one | [Organization](/reference/people/organization/) | No |
| `person` | To one | [Person](/reference/people/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` |
| `note` | `string` | Equality only |
| `note_category_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`, `display_date`, `id`, `note`, `note_category_id`, `updated_at`.

## Edges

Follow these from one Note, `ref = pco.people.notes.id(noteId)`:

| Edge | Leads to | Returns | Filters | Create |
| --- | --- | --- | --- | --- |
| `ref.category` | [NoteCategory](/reference/people/note-category/) | Collection |  | No |
| `ref.created_by` | [Person](/reference/people/person/) | Collection |  | No |
| `ref.person` | [Person](/reference/people/person/) | Collection |  | No |

## Writing

| Property | Value |
| --- | --- |
| Create | Yes, `create()` on `notes` on [Person](/reference/people/person/) |
| Update | Yes, `update()` on a reference |
| Delete | Yes, `delete()` on a reference |

### Create attributes

Typed as `People.NoteSchema['create']`.

| Attribute | Type |
| --- | --- |
| `created_at` | `string \| null` |
| `display_date` | `string \| null` |
| `note` | `string \| null` |
| `note_category_id` | `number \| null` |
| `updated_at` | `string \| null` |

### Update attributes

Typed as `People.NoteSchema['update']`.

| Attribute | Type |
| --- | --- |
| `created_at` | `string \| null` |
| `display_date` | `string \| null` |
| `note` | `string \| null` |
| `note_category_id` | `number \| null` |
| `updated_at` | `string \| null` |

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

## Example

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

const page = await pco.people.notes.order('created_at').perPage(25).list();
const items: People.Note[] = page.data;
```

Source: https://planningcenterkit.mackenly.com/reference/people/note/index.mdx
