A field option on a custom form field.
| Property | Value |
|---|---|
| Product | People (pco.people, API version 2026-10-05) |
| Resource type | FormFieldOption |
| TypeScript | People.FormFieldOption, attributes People.FormFieldOptionAttributes, schema People.FormFieldOptionSchema |
| Planning Center path | /people/v2/forms/{form_id}/fields/{field_id}/options |
| Planning Center docs | FormFieldOption |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.people.forms.id(formId).fields.id(formFieldId).options |
Collection | No |
From a collection, .id(formFieldOptionId) addresses one FormFieldOption: pco.people.forms.id(formId).fields.id(formFieldId).options.id(formFieldOptionId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On People.FormFieldOptionAttributes. Every resource also has id and type ('FormFieldOption') next to its attributes.
| Name | Type | Description |
|---|---|---|
created_at |
string | null |
|
label |
string | null |
|
sequence |
number | null |
|
updated_at |
string | null |
Relationships and includes
Planning Center documents no includes for this resource.
| Relationship | Type | To | Includable |
|---|---|---|---|
form_field |
To one | FormField | No |
optionable |
To one | Optionable |
No |
Querying
No documented where fields.
Order
order(...) accepts these fields, ascending, or descending with a - prefix: created_at, sequence, updated_at.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { People } from '@mackenly/planningcenterkit';
const formId = '1'; // Form id
const formFieldId = '1'; // FormField id
const page = await pco.people.forms.id(formId).fields.id(formFieldId).options.order('created_at').perPage(25).list();
const items: People.FormFieldOption[] = page.data;