Skip to content

FormFieldCondition (People)

A rule that conditionally shows a form field based on the answer given to another (trigger) field.

A rule that conditionally shows a form field based on the answer given to another (trigger) field.

A condition belongs to the form_field it shows, and points at a trigger_form_field whose answer determines whether that field is displayed. A form field can have at most one condition. The trigger is matched in one of two ways:

  • trigger_form_field_option — the condition is met when the answer to the trigger field is this option (used for option-based fields such as dropdowns, gender, campus, etc.).
  • trigger_form_field_option_value — the condition is met when the answer to the trigger field equals this string (used for boolean custom fields).

When neither is set, the condition is met whenever the trigger field has any answer.

Conditions are created, updated, and destroyed under the form field they belong to (POST/PATCH/DELETE .../fields/{id}/form_field_conditions). The form_field and trigger_form_field must both belong to the same form, and the trigger_form_field_option must belong to the trigger_form_field. Writing requires permission to manage the form.

Property Value
Product People (pco.people, API version 2026-10-05)
Resource type FormFieldCondition
TypeScript People.FormFieldCondition, attributes People.FormFieldConditionAttributes, schema People.FormFieldConditionSchema
Planning Center path /people/v2/forms/{form_id}/fields/{field_id}/form_field_conditions
Planning Center docs FormFieldCondition

How to reach it

Client path Returns Filters Create
pco.people.forms.id(formId).fields.id(formFieldId).form_field_conditions Collection Yes

From a collection, .id(formFieldConditionId) addresses one FormFieldCondition: pco.people.forms.id(formId).fields.id(formFieldId).form_field_conditions.id(formFieldConditionId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On People.FormFieldConditionAttributes. Every resource also has id and type ('FormFieldCondition') next to its attributes.

Name Type Description
created_at string | null
trigger_form_field_option_value string | null Set when the condition is triggered by a specific text value (e.g. a boolean custom field) instead of a trigger_form_field_option.
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
trigger_form_field To one FormField No
trigger_form_field_option To one FormFieldOption No

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
updated_at string | Date gt, gte, lt, lte

Order

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

Edges

This resource has no documented edges.

Writing

Property Value
Create Yes, create() on form_field_conditions on FormField
Update Yes, update() on a reference
Delete Yes, delete() on a reference

Create attributes

Typed as People.FormFieldConditionSchema['create'].

Attribute Type
form_field_id string
trigger_form_field_id string
trigger_form_field_option_id string
trigger_form_field_option_value string | null

Update attributes

Typed as People.FormFieldConditionSchema['update'].

Attribute Type
form_field_id string
trigger_form_field_id string
trigger_form_field_option_id string
trigger_form_field_option_value string | null

See Writing data.

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).form_field_conditions.order('created_at').perPage(25).list();
const items: People.FormFieldCondition[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close