An address represents a physical and/or mailing address for a person.
| Property | Value |
|---|---|
| Product | People (pco.people, API version 2026-10-05) |
| Resource type | Address |
| TypeScript | People.Address, attributes People.AddressAttributes, schema People.AddressSchema |
| Planning Center path | /people/v2/addresses |
| Planning Center docs | Address |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.people.addresses |
Collection | No | |
pco.people.people.id(personId).addresses |
Collection | Yes |
From a collection, .id(addressId) addresses one Address: pco.people.addresses.id(addressId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On People.AddressAttributes. Every resource also has id and type ('Address') next to its attributes.
| Name | Type | Description |
|---|---|---|
city |
string | null |
|
country_code |
string | null |
|
country_name |
string | null |
|
created_at |
string | null |
|
location |
string | null |
|
primary |
boolean | null |
|
state |
string | null |
|
street_line_1 |
string | null |
|
street_line_2 |
string | null |
|
updated_at |
string | null |
|
zip |
string | 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 |
|---|---|---|
city |
string |
Equality only |
country_code |
string |
Equality only |
location |
string |
Equality only |
primary |
boolean |
Equality only |
state |
string |
Equality only |
street_line_1 |
string |
Equality only |
street_line_2 |
string |
Equality only |
zip |
string |
Equality only |
Order
order(...) accepts these fields, ascending, or descending with a - prefix: city, country_code, created_at, location, primary, state, street_line_1, street_line_2, updated_at, zip.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | Yes, create() on addresses on Person |
| Update | Yes, update() on a reference |
| Delete | Yes, delete() on a reference |
Create attributes
Typed as People.AddressSchema['create'].
| Attribute | Type |
|---|---|
city |
string | null |
country_code |
string | null |
location |
string | null |
primary |
boolean | null |
state |
string | null |
street_line_1 |
string | null |
street_line_2 |
string | null |
zip |
string | null |
Update attributes
Typed as People.AddressSchema['update'].
| Attribute | Type |
|---|---|
city |
string | null |
country_code |
string | null |
location |
string | null |
primary |
boolean | null |
state |
string | null |
street_line_1 |
string | null |
street_line_2 |
string | null |
zip |
string | null |
See Writing data.
Example
import type { People } from '@mackenly/planningcenterkit';
const page = await pco.people.addresses.order('city').perPage(25).list();
const items: People.Address[] = page.data;