---
title: "ListShare (People)"
description: "A list share indicates who has access to edit a list."
---

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

# ListShare (People)

A list share indicates who has access to edit a list.

| Property | Value |
| --- | --- |
| Product | [People](/reference/people/) (`pco.people`, API version `2026-10-05`) |
| Resource type | `ListShare` |
| TypeScript | `People.ListShare`, attributes `People.ListShareAttributes`, schema `People.ListShareSchema` |
| Planning Center path | `/people/v2/lists/{list_id}/shares` |
| Planning Center docs | [ListShare](https://api.planningcenteronline.com/docs/apps/people/versions/2026-10-05/vertices/list_share) |

## How to reach it

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

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

## Attributes

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

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

## Relationships and includes

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

| Relationship | Type | To | Includable |
| --- | --- | --- | --- |
| `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` |
| `group` | `string` | Equality only |
| `name` | `string` | Equality only |
| `permission` | `string` | Equality only |

### Order

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

## Edges

Follow these from one ListShare, `ref = pco.people.lists.id(listId).shares.id(listShareId)`:

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

## Writing

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

### Create attributes

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

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

### Update attributes

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

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

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

## Example

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

const listId = '1'; // List id

const page = await pco.people.lists.id(listId).shares.order('created_at').perPage(25).list();
const items: People.ListShare[] = page.data;
```

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