---
title: "NoteCategoryShare (People)"
description: "A note category share defines who can view notes in a category."
---

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

# NoteCategoryShare (People)

A note category share defines who can view notes in a category.

| Property | Value |
| --- | --- |
| Product | [People](/reference/people/) (`pco.people`, API version `2026-10-05`) |
| Resource type | `NoteCategoryShare` |
| TypeScript | `People.NoteCategoryShare`, attributes `People.NoteCategoryShareAttributes`, schema `People.NoteCategoryShareSchema` |
| Planning Center path | `/people/v2/note_categories/{note_category_id}/shares` |
| Planning Center docs | [NoteCategoryShare](https://api.planningcenteronline.com/docs/apps/people/versions/2026-10-05/vertices/note_category_share) |

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.people.note_categories.id(noteCategoryId).shares` | Collection |  | Yes |

From a collection, `.id(noteCategoryShareId)` addresses one NoteCategoryShare: `pco.people.note_categories.id(noteCategoryId).shares.id(noteCategoryShareId)`. Collections support [`where`, `include`, `order`, and pagination](/guides/querying/); single resources have `get()`.

## Attributes

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

| Name | Type | Description |
| --- | --- | --- |
| `group` | `string \| null` | Possible values: `No Access`, `Viewer`, `Editor`, or `Manager` |
| `permission` | `string \| null` | Possible values: `view`, `view_create`, or `manage` |
| `person_id` | `number \| null` |  |

## Relationships and includes

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

| Relationship | Type | To | Includable |
| --- | --- | --- | --- |
| `note_category` | To one | [NoteCategory](/reference/people/note-category/) | 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 |
| --- | --- | --- |
| `permission` | `string` | Equality only |

No documented `order` fields.

## Edges

Follow these from one NoteCategoryShare, `ref = pco.people.note_categories.id(noteCategoryId).shares.id(noteCategoryShareId)`:

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

## Writing

| Property | Value |
| --- | --- |
| Create | Yes, `create()` on `shares` on [NoteCategory](/reference/people/note-category/) |
| Update | Yes, `update()` on a reference |
| Delete | Yes, `delete()` on a reference |

### Create attributes

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

| Attribute | Type |
| --- | --- |
| `group` | `string \| null` |
| `permission` | `string \| null` |
| `person_id` | `number \| null` |

### Update attributes

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

| Attribute | Type |
| --- | --- |
| `group` | `string \| null` |
| `permission` | `string \| null` |
| `person_id` | `number \| null` |

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

## Example

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

const noteCategoryId = '1'; // NoteCategory id

const page = await pco.people.note_categories.id(noteCategoryId).shares.perPage(25).list();
const items: People.NoteCategoryShare[] = page.data;
```

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