---
title: "SchoolOption (People)"
description: "A school option represents a school name, school type, grades, etc."
---

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

# SchoolOption (People)

A school option represents a school name, school type, grades, etc. and can be selected for a person.

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

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.people.school_options` | Collection |  | Yes |
| `pco.people.people.id(personId).school` | Collection |  | No |
| `pco.people.school_options.id(schoolOptionId).promotes_to_school` | Collection |  | No |

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

## Attributes

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

| Name | Type | Description |
| --- | --- | --- |
| `beginning_grade` | `string \| null` |  |
| `ending_grade` | `string \| null` |  |
| `school_types` | `unknown[] \| null` |  |
| `sequence` | `number \| null` |  |
| `value` | `string \| null` |  |

## Querying

### Where

`where(field, value)` for equality; `where(field, op, value)` with the operators listed.

| Field | Value type | Operators |
| --- | --- | --- |
| `beginning_grade` | `string` | Equality only |
| `ending_grade` | `string` | Equality only |
| `school_types` | `string` | Equality only |
| `sequence` | `number` | Equality only |
| `value` | `string` | Equality only |

### Order

`order(...)` accepts these fields, ascending, or descending with a `-` prefix: `beginning_grade`, `ending_grade`, `sequence`, `value`.

## Edges

Follow these from one SchoolOption, `ref = pco.people.school_options.id(schoolOptionId)`:

| Edge | Leads to | Returns | Filters | Create |
| --- | --- | --- | --- | --- |
| `ref.promotes_to_school` | [SchoolOption](/reference/people/school-option/) | Collection |  | No |

## Writing

| Property | Value |
| --- | --- |
| Create | Yes, `create()` on `pco.people.school_options` |
| Update | Yes, `update()` on a reference |
| Delete | Yes, `delete()` on a reference |

### Create attributes

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

| Attribute | Type |
| --- | --- |
| `beginning_grade` | `string \| null` |
| `ending_grade` | `string \| null` |
| `promotes_to_school_id` | `string` |
| `school_types` | `unknown[] \| null` |
| `sequence` | `number \| null` |
| `value` | `string \| null` |

### Update attributes

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

| Attribute | Type |
| --- | --- |
| `beginning_grade` | `string \| null` |
| `ending_grade` | `string \| null` |
| `promotes_to_school_id` | `string` |
| `school_types` | `unknown[] \| null` |
| `sequence` | `number \| null` |
| `value` | `string \| null` |

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

## Example

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

const page = await pco.people.school_options.order('beginning_grade').perPage(25).list();
const items: People.SchoolOption[] = page.data;
```

Source: https://planningcenterkit.mackenly.com/reference/people/school-option/index.mdx
