---
title: "FieldOption (People)"
description: "A field option represents an individual option for a custom field of type \"select\" or \"checkboxes\"."
---

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

# FieldOption (People)

A field option represents an individual option for a custom field of type "select" or "checkboxes".

| Property | Value |
| --- | --- |
| Product | [People](/reference/people/) (`pco.people`, API version `2026-10-05`) |
| Resource type | `FieldOption` |
| TypeScript | `People.FieldOption`, attributes `People.FieldOptionAttributes`, schema `People.FieldOptionSchema` |
| Planning Center path | `/people/v2/field_definitions/{field_definition_id}/field_options` |
| Planning Center docs | [FieldOption](https://api.planningcenteronline.com/docs/apps/people/versions/2026-10-05/vertices/field_option) |

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.people.field_data.id(fieldDatumId).field_option` | Collection |  | No |
| `pco.people.field_definitions.id(fieldDefinitionId).field_options` | Collection |  | Yes |
| `pco.people.tabs.id(tabId).field_options` | Collection |  | No |

From a collection, `.id(fieldOptionId)` addresses one FieldOption: `pco.people.field_data.id(fieldDatumId).field_option.id(fieldOptionId)`. Collections support [`where`, `include`, `order`, and pagination](/guides/querying/); single resources have `get()`.

## Attributes

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

| Name | Type | Description |
| --- | --- | --- |
| `sequence` | `number \| null` |  |
| `value` | `string \| null` |  |

## Relationships and includes

Planning Center documents no includes for this resource.

| Relationship | Type | To | Includable |
| --- | --- | --- | --- |
| `field_definition` | To one | [FieldDefinition](/reference/people/field-definition/) | No |

## Querying

### Where

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

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

### Order

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

## Edges

This resource has no documented edges.

## Writing

| Property | Value |
| --- | --- |
| Create | Yes, `create()` on `field_options` on [FieldDefinition](/reference/people/field-definition/) |
| Update | Yes, `update()` on a reference |
| Delete | Yes, `delete()` on a reference |

### Create attributes

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

| Attribute | Type |
| --- | --- |
| `sequence` | `number \| null` |
| `value` | `string \| null` |

### Update attributes

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

| Attribute | Type |
| --- | --- |
| `sequence` | `number \| null` |
| `value` | `string \| null` |

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

## Example

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

const fieldDatumId = '1'; // FieldDatum id

const page = await pco.people.field_data.id(fieldDatumId).field_option.order('sequence').perPage(25).list();
const items: People.FieldOption[] = page.data;
```

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