Skip to content

Email (Services)

A persons email

A persons email

Property Value
Product Services (pco.services, API version 2018-11-01)
Resource type Email
TypeScript Services.Email, attributes Services.EmailAttributes, schema Services.EmailSchema
Planning Center path /services/v2/people/{person_id}/emails
Planning Center docs Email

How to reach it

Client path Returns Filters Create
pco.services.people.id(personId).emails Collection No

From a collection, .id(emailId) addresses one Email: pco.services.people.id(personId).emails.id(emailId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Services.EmailAttributes. Every resource also has id and type ('Email') next to its attributes.

Name Type Description
address string | null
primary boolean | null

Querying

No documented where fields.

No documented order fields.

Edges

This resource has no documented edges.

Writing

Property Value
Create No
Update No
Delete No

Example

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

const personId = '1'; // Person id

const page = await pco.services.people.id(personId).emails.perPage(25).list();
const items: Services.Email[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close