| Property | Value |
|---|---|
| Product | People (pco.people, API version 2026-10-05) |
| Resource type | Carrier |
| TypeScript | People.Carrier, attributes People.CarrierAttributes, schema People.CarrierSchema |
| Planning Center path | /people/v2/carriers |
| Planning Center docs | Carrier |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.people.carriers |
Collection | No |
From a collection, .id(carrierId) addresses one Carrier: pco.people.carriers.id(carrierId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On People.CarrierAttributes. Every resource also has id and type ('Carrier') next to its attributes.
| Name | Type | Description |
|---|---|---|
international |
boolean | null |
|
name |
string | null |
|
value |
string | null |
Querying
No documented where fields.
Order
order(...) accepts these fields, ascending, or descending with a - prefix: international, name.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { People } from '@mackenly/planningcenterkit';
const page = await pco.people.carriers.order('international').perPage(25).list();
const items: People.Carrier[] = page.data;