---
title: "Form (People)"
description: "A custom form for people to fill out."
---

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

# Form (People)

A custom form for people to fill out.

| Property | Value |
| --- | --- |
| Product | [People](/reference/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](https://api.planningcenteronline.com/docs/apps/people/versions/2026-10-05/vertices/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](/guides/querying/); 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](/reference/people/campus/) | Yes |
| `form_category` | To one | [FormCategory](/reference/people/form-category/) | 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](/reference/people/campus/) | Collection |  | No |
| `ref.category` | [FormCategory](/reference/people/form-category/) | Collection |  | No |
| `ref.fields` | [FormField](/reference/people/form-field/) | Collection |  | No |
| `ref.form_submissions` | [FormSubmission](/reference/people/form-submission/) | Collection |  | Yes |

## Writing

| Property | Value |
| --- | --- |
| Create | No |
| Update | No |
| Delete | No |

## Example

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

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

Source: https://planningcenterkit.mackenly.com/reference/people/form/index.mdx
