Skip to content

PhoneNumber (People)

A phone number represents a single telephone number and location.

A phone number represents a single telephone number and location.

Property Value
Product People (pco.people, API version 2026-10-05)
Resource type PhoneNumber
TypeScript People.PhoneNumber, attributes People.PhoneNumberAttributes, schema People.PhoneNumberSchema
Planning Center path /people/v2/phone_numbers
Planning Center docs PhoneNumber

How to reach it

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

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

Attributes

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

Name Type Description
carrier string | null
country_code string | null
created_at string | null
e164 string | null
formatted_number string | null Only available when requested with the ?fields param
international string | null
location string | null
national string | null
number 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
carrier string Equality only
created_at string | Date gt, gte, lt, lte
location string Equality only
number 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: carrier, created_at, location, number, primary, updated_at.

Edges

This resource has no documented edges.

Writing

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

Create attributes

Typed as People.PhoneNumberSchema['create'].

Attribute Type
carrier string | null
location string | null
number string | null
primary boolean | null

Update attributes

Typed as People.PhoneNumberSchema['update'].

Attribute Type
carrier string | null
location string | null
number string | null
primary boolean | null

See Writing data.

Example

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

const page = await pco.people.phone_numbers.order('carrier').perPage(25).list();
const items: People.PhoneNumber[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close