A tab is a custom tab and groups like field definitions.
| Property | Value |
|---|---|
| Product | People (pco.people, API version 2026-10-05) |
| Resource type | Tab |
| TypeScript | People.Tab, attributes People.TabAttributes, schema People.TabSchema |
| Planning Center path | /people/v2/tabs |
| Planning Center docs | Tab |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.people.tabs |
Collection | with_field_definitions |
Yes |
pco.people.field_data.id(fieldDatumId).tab |
Collection | No | |
pco.people.field_definitions.id(fieldDefinitionId).tab |
Collection | No |
From a collection, .id(tabId) addresses one Tab: pco.people.tabs.id(tabId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On People.TabAttributes. Every resource also has id and type ('Tab') next to its attributes.
| Name | Type | Description |
|---|---|---|
name |
string | null |
|
sequence |
number | null |
|
slug |
string | null |
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): field_definitions, field_options.
Querying
Where
where(field, value) for equality; where(field, op, value) with the operators listed.
| Field | Value type | Operators |
|---|---|---|
name |
string |
Equality only |
sequence |
number |
Equality only |
slug |
string |
Equality only |
Order
order(...) accepts these fields, ascending, or descending with a - prefix: name, sequence, slug.
Filters
filter(...) names depend on the edge you query through:
| Edge | Filters |
|---|---|
pco.people.tabs |
with_field_definitions |
Edges
Follow these from one Tab, ref = pco.people.tabs.id(tabId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.field_definitions |
FieldDefinition | Collection | with_deleted |
Yes |
ref.field_options |
FieldOption | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | Yes, create() on pco.people.tabs |
| Update | Yes, update() on a reference |
| Delete | Yes, delete() on a reference |
Create attributes
Typed as People.TabSchema['create'].
| Attribute | Type |
|---|---|
name |
string | null |
sequence |
number | null |
Update attributes
Typed as People.TabSchema['update'].
| Attribute | Type |
|---|---|
name |
string | null |
sequence |
number | null |
See Writing data.
Example
import type { People } from '@mackenly/planningcenterkit';
const page = await pco.people.tabs.order('name').perPage(25).list();
const items: People.Tab[] = page.data;