Skip to content

FieldDatum (People)

A field datum is an individual piece of data for a custom field.

A field datum is an individual piece of data for a custom field.

Property Value
Product People (pco.people, API version 2026-10-05)
Resource type FieldDatum
TypeScript People.FieldDatum, attributes People.FieldDatumAttributes, schema People.FieldDatumSchema
Planning Center path /people/v2/field_data
Planning Center docs FieldDatum

How to reach it

Client path Returns Filters Create
pco.people.field_data Collection No
pco.people.people.id(personId).field_data Collection Yes

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

Attributes

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

Name Type Description
created_at string | null
file Record<string, unknown> | null
file_content_type string | null
file_name string | null
file_size number | null
updated_at string | null
value string | null

Relationships and includes

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

Relationship Type To Includable
customizable To one Customizable No
field_definition To one FieldDefinition Yes

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
field_definition_id string | number Equality only
file unknown Equality only
file_content_type string Equality only
file_name string Equality only
file_size number Equality only
updated_at string | Date gt, gte, lt, lte
value string Equality only

Order

order(...) accepts these fields, ascending, or descending with a - prefix: created_at, file, file_content_type, file_name, file_size, updated_at, value.

Edges

Follow these from one FieldDatum, ref = pco.people.field_data.id(fieldDatumId):

Edge Leads to Returns Filters Create
ref.field_definition FieldDefinition Collection No
ref.field_option FieldOption Collection No
ref.person Person Collection No
ref.tab Tab Collection No

Writing

Property Value
Create Yes, create() on field_data on Person
Update Yes, update() on a reference
Delete Yes, delete() on a reference

Create attributes

Typed as People.FieldDatumSchema['create'].

Attribute Type
field_definition_id string
value string | null

Update attributes

Typed as People.FieldDatumSchema['update'].

Attribute Type
field_definition_id string
value string | null

See Writing data.

Example

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

const page = await pco.people.field_data.order('created_at').perPage(25).list();
const items: People.FieldDatum[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close