A field in a custom form.
| Property | Value |
|---|---|
| Product | People (pco.people, API version 2026-10-05) |
| Resource type | FormField |
| TypeScript | People.FormField, attributes People.FormFieldAttributes, schema People.FormFieldSchema |
| Planning Center path | /people/v2/forms/{form_id}/fields |
| Planning Center docs | FormField |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.people.forms.id(formId).fields |
Collection | No | |
pco.people.forms.id(formId).form_submissions.id(formSubmissionId).form_fields |
Collection | No |
From a collection, .id(formFieldId) addresses one FormField: pco.people.forms.id(formId).fields.id(formFieldId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On People.FormFieldAttributes. Every resource also has id and type ('FormField') next to its attributes.
| Name | Type | Description |
|---|---|---|
created_at |
string | null |
|
description |
string | null |
|
field_type |
string | null |
See details. |
label |
string | null |
|
required |
boolean | null |
|
sequence |
number | null |
|
settings |
Record<string, unknown> | null |
|
updated_at |
string | null |
Attribute details
field_type
Possible values: string, text, checkboxes, dropdown, date, phone_number, address, birthday, gender, custom_field, note, workflow, heading, number, boolean, file, medical, workflow_checkbox, workflow_checkboxes, workflow_dropdown, marital_status, anniversary, grade, primary_campus, school, or household
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): form_field_conditions, options.
| Relationship | Type | To | Includable |
|---|---|---|---|
fieldable |
To one | Fieldable |
No |
form |
To one | Form | No |
form_field_conditions |
To many | FormFieldCondition | Yes |
options |
To one | FormFieldOption | Yes |
Querying
No documented where fields.
Order
order(...) accepts these fields, ascending, or descending with a - prefix: created_at, sequence, updated_at.
Edges
Follow these from one FormField, ref = pco.people.forms.id(formId).fields.id(formFieldId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.form_field_conditions |
FormFieldCondition | Collection | Yes | |
ref.options |
FormFieldOption | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { People } from '@mackenly/planningcenterkit';
const formId = '1'; // Form id
const page = await pco.people.forms.id(formId).fields.order('created_at').perPage(25).list();
const items: People.FormField[] = page.data;