A name prefix is one of Mr., Mrs., etc.
| Property | Value |
|---|---|
| Product | People (pco.people, API version 2026-10-05) |
| Resource type | NamePrefix |
| TypeScript | People.NamePrefix, attributes People.NamePrefixAttributes, schema People.NamePrefixSchema |
| Planning Center path | /people/v2/name_prefixes |
| Planning Center docs | NamePrefix |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.people.name_prefixes |
Collection | Yes | |
pco.people.people.id(personId).name_prefix |
Collection | No |
From a collection, .id(namePrefixId) addresses one NamePrefix: pco.people.name_prefixes.id(namePrefixId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On People.NamePrefixAttributes. Every resource also has id and type ('NamePrefix') next to its attributes.
| Name | Type | Description |
|---|---|---|
value |
string | null |
Querying
Where
where(field, value) for equality; where(field, op, value) with the operators listed.
| Field | Value type | Operators |
|---|---|---|
value |
string |
Equality only |
Order
order(...) accepts these fields, ascending, or descending with a - prefix: value.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | Yes, create() on pco.people.name_prefixes |
| Update | Yes, update() on a reference |
| Delete | Yes, delete() on a reference |
Create attributes
Typed as People.NamePrefixSchema['create'].
| Attribute | Type |
|---|---|
value |
string | null |
Update attributes
Typed as People.NamePrefixSchema['update'].
| Attribute | Type |
|---|---|
value |
string | null |
See Writing data.
Example
import type { People } from '@mackenly/planningcenterkit';
const page = await pco.people.name_prefixes.order('value').perPage(25).list();
const items: People.NamePrefix[] = page.data;