Skip to content

Form (People)

A custom form for people to fill out.

A custom form for people to fill out.

Property Value
Product People (pco.people, API version 2026-10-05)
Resource type Form
TypeScript People.Form, attributes People.FormAttributes, schema People.FormSchema
Planning Center path /people/v2/forms
Planning Center docs Form

How to reach it

Client path Returns Filters Create
pco.people.forms Collection archived, closed, has_active_automations, not_archived, open, recently_deleted, recently_viewed, unassigned, with_recoverable No
pco.people.forms.id(formId).form_submissions.id(formSubmissionId).form Collection No

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

Attributes

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

Name Type Description
active boolean | null
allow_submitting_for_household_members boolean | null Only available if the ‘Submit for household member’ feature is enabled.
archived boolean | null
archived_at string | null
can_manage boolean | null
created_at string | null
deleted_at string | null
description string | null
login_required boolean | null
name string | null
public_url string | null
recently_viewed boolean | null
send_submission_notification_to_submitter boolean | null
submission_count number | null
updated_at string | null

Relationships and includes

Side-load with include() (or get({ include })) and read with related(resource, name): campus, category.

Relationship Type To Includable
campus To one Campus Yes
form_category To one FormCategory No

Querying

Where

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

Field Value type Operators
active boolean Equality only
id string Equality only

Order

order(...) accepts these fields, ascending, or descending with a - prefix: active, active_automations_count, archived_at, campus, category, created_at, deleted_at, description, last_submitted_at, name, recently_viewed, submission_count, updated_at.

Filters

filter(...) names depend on the edge you query through:

Edge Filters
pco.people.forms archived, closed, has_active_automations, not_archived, open, recently_deleted, recently_viewed, unassigned, with_recoverable

Edges

Follow these from one Form, ref = pco.people.forms.id(formId):

Edge Leads to Returns Filters Create
ref.campus Campus Collection No
ref.category FormCategory Collection No
ref.fields FormField Collection No
ref.form_submissions FormSubmission Collection Yes

Writing

Property Value
Create No
Update No
Delete No

Example

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

const page = await pco.people.forms.order('active').perPage(25).list();
const items: People.Form[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close