An email represents an email address and location.
| Property | Value |
|---|---|
| Product | People (pco.people, API version 2026-10-05) |
| Resource type | Email |
| TypeScript | People.Email, attributes People.EmailAttributes, schema People.EmailSchema |
| Planning Center path | /people/v2/emails |
| Planning Center docs |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.people.emails |
Collection | No | |
pco.people.people.id(personId).emails |
Collection | Yes |
From a collection, .id(emailId) addresses one Email: pco.people.emails.id(emailId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On People.EmailAttributes. Every resource also has id and type ('Email') next to its attributes.
| Name | Type | Description |
|---|---|---|
address |
string | null |
|
blocked |
boolean | null |
|
created_at |
string | null |
|
location |
string | null |
|
primary |
boolean | null |
|
updated_at |
string | null |
|
verified |
boolean | null |
Relationships and includes
Planning Center documents no includes for this resource.
| Relationship | Type | To | Includable |
|---|---|---|---|
person |
To one | Person | No |
Querying
Where
where(field, value) for equality; where(field, op, value) with the operators listed.
| Field | Value type | Operators |
|---|---|---|
address |
string |
Equality only |
blocked |
boolean |
Equality only |
created_at |
string | Date |
gt, gte, lt, lte |
location |
string |
Equality only |
primary |
boolean |
Equality only |
updated_at |
string | Date |
gt, gte, lt, lte |
Order
order(...) accepts these fields, ascending, or descending with a - prefix: address, created_at, location, primary, updated_at.
Edges
Follow these from one Email, ref = pco.people.emails.id(emailId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.person |
Person | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | Yes, create() on emails on Person |
| Update | Yes, update() on a reference |
| Delete | Yes, delete() on a reference |
Create attributes
Typed as People.EmailSchema['create'].
| Attribute | Type |
|---|---|
address |
string | null |
location |
string | null |
primary |
boolean | null |
Update attributes
Typed as People.EmailSchema['update'].
| Attribute | Type |
|---|---|
address |
string | null |
location |
string | null |
primary |
boolean | null |
See Writing data.
Example
import type { People } from '@mackenly/planningcenterkit';
const page = await pco.people.emails.order('address').perPage(25).list();
const items: People.Email[] = page.data;