---
title: "FieldDefinition (People)"
description: "A field definition represents a custom field -- its name, data type, etc."
---

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

# FieldDefinition (People)

A field definition represents a custom field -- its name, data type, etc.

| Property | Value |
| --- | --- |
| Product | [People](/reference/people/) (`pco.people`, API version `2026-10-05`) |
| Resource type | `FieldDefinition` |
| TypeScript | `People.FieldDefinition`, attributes `People.FieldDefinitionAttributes`, schema `People.FieldDefinitionSchema` |
| Planning Center path | `/people/v2/field_definitions` |
| Planning Center docs | [FieldDefinition](https://api.planningcenteronline.com/docs/apps/people/versions/2026-10-05/vertices/field_definition) |

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.people.field_definitions` | Collection | `include_deleted` | No |
| `pco.people.field_data.id(fieldDatumId).field_definition` | Collection |  | No |
| `pco.people.tabs.id(tabId).field_definitions` | Collection | `with_deleted` | Yes |

From a collection, `.id(fieldDefinitionId)` addresses one FieldDefinition: `pco.people.field_definitions.id(fieldDefinitionId)`. Collections support [`where`, `include`, `order`, and pagination](/guides/querying/); single resources have `get()`.

## Attributes

On `People.FieldDefinitionAttributes`. Every resource also has `id` and `type` (`'FieldDefinition'`) next to its attributes.

| Name | Type | Description |
| --- | --- | --- |
| `config` | `Record<string, unknown> \| null` |  |
| `data_type` | `string \| null` |  |
| `deleted_at` | `string \| null` |  |
| `name` | `string \| null` |  |
| `sequence` | `number \| null` |  |
| `slug` | `string \| null` |  |
| `tab_id` | `number \| null` |  |

## Relationships and includes

Side-load with `include()` (or `get({ include })`) and read with `related(resource, name)`: `field_options`, `tab`.

| Relationship | Type | To | Includable |
| --- | --- | --- | --- |
| `tab` | To one | [Tab](/reference/people/tab/) | Yes |

## Querying

### Where

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

| Field | Value type | Operators |
| --- | --- | --- |
| `config` | `unknown` | Equality only |
| `data_type` | `string` | Equality only |
| `deleted_at` | `string \| Date` | `gt`, `gte`, `lt`, `lte` |
| `name` | `string` | Equality only |
| `sequence` | `number` | Equality only |
| `slug` | `string` | Equality only |
| `tab_id` | `string \| number` | Equality only |

### Order

`order(...)` accepts these fields, ascending, or descending with a `-` prefix: `config`, `data_type`, `deleted_at`, `name`, `sequence`, `slug`, `tab_id`.

### Filters

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

| Edge | Filters |
| --- | --- |
| `pco.people.field_definitions` | `include_deleted` |
| `field_definitions` on [Tab](/reference/people/tab/) | `with_deleted` |

## Edges

Follow these from one FieldDefinition, `ref = pco.people.field_definitions.id(fieldDefinitionId)`:

| Edge | Leads to | Returns | Filters | Create |
| --- | --- | --- | --- | --- |
| `ref.field_options` | [FieldOption](/reference/people/field-option/) | Collection |  | Yes |
| `ref.tab` | [Tab](/reference/people/tab/) | Collection |  | No |

## Writing

| Property | Value |
| --- | --- |
| Create | Yes, `create()` on `field_definitions` on [Tab](/reference/people/tab/) |
| Update | Yes, `update()` on a reference |
| Delete | Yes, `delete()` on a reference |

### Create attributes

Typed as `People.FieldDefinitionSchema['create']`.

| Attribute | Type |
| --- | --- |
| `config` | `Record<string, unknown> \| null` |
| `data_type` | `string \| null` |
| `deleted_at` | `string \| null` |
| `name` | `string \| null` |
| `sequence` | `number \| null` |
| `slug` | `string \| null` |

### Update attributes

Typed as `People.FieldDefinitionSchema['update']`.

| Attribute | Type |
| --- | --- |
| `config` | `Record<string, unknown> \| null` |
| `data_type` | `string \| null` |
| `deleted_at` | `string \| null` |
| `name` | `string \| null` |
| `sequence` | `number \| null` |
| `slug` | `string \| null` |

See [Writing data](/guides/writing-data/).

## Example

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

const page = await pco.people.field_definitions.order('config').perPage(25).list();
const items: People.FieldDefinition[] = page.data;
```

Source: https://planningcenterkit.mackenly.com/reference/people/field-definition/index.mdx
