Skip to content

ListCategory (People)

A List Category

A List Category

Property Value
Product People (pco.people, API version 2026-10-05)
Resource type ListCategory
TypeScript People.ListCategory, attributes People.ListCategoryAttributes, schema People.ListCategorySchema
Planning Center path /people/v2/list_categories
Planning Center docs ListCategory

How to reach it

Client path Returns Filters Create
pco.people.list_categories Collection Yes
pco.people.lists.id(listId).category Collection No

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

Attributes

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

Name Type Description
created_at string | null
name string | null
organization_id number | null
updated_at string | null

Relationships and includes

Side-load with include() (or get({ include })) and read with related(resource, name): lists.

Relationship Type To Includable
organization To one Organization No

Querying

Where

where(field, value) for equality; where(field, op, value) with the operators listed.

Field Value type Operators
created_at string | Date gt, gte, lt, lte
name string Equality only
organization_id string | number Equality only
updated_at string | Date gt, gte, lt, lte

Order

order(...) accepts these fields, ascending, or descending with a - prefix: created_at, name, organization_id, updated_at.

Edges

Follow these from one ListCategory, ref = pco.people.list_categories.id(listCategoryId):

Edge Leads to Returns Filters Create
ref.lists List Collection No

Writing

Property Value
Create Yes, create() on pco.people.list_categories
Update Yes, update() on a reference
Delete Yes, delete() on a reference

Create attributes

Typed as People.ListCategorySchema['create'].

Attribute Type
name string | null

Update attributes

Typed as People.ListCategorySchema['update'].

Attribute Type
name string | null

See Writing data.

Example

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

const page = await pco.people.list_categories.order('created_at').perPage(25).list();
const items: People.ListCategory[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close