Skip to content

WorkflowCategory (People)

A Workflow Category

A Workflow Category

Property Value
Product People (pco.people, API version 2026-10-05)
Resource type WorkflowCategory
TypeScript People.WorkflowCategory, attributes People.WorkflowCategoryAttributes, schema People.WorkflowCategorySchema
Planning Center path /people/v2/workflows/{workflow_id}/category
Planning Center docs WorkflowCategory

How to reach it

Client path Returns Filters Create
pco.people.workflows.id(workflowId).category Collection No

From a collection, .id(workflowCategoryId) addresses one WorkflowCategory: pco.people.workflows.id(workflowId).category.id(workflowCategoryId). Collections support where, include, order, and pagination; single resources have get().

Attributes

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

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

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
updated_at string | Date gt, gte, lt, lte

Order

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

Edges

This resource has no documented edges.

Writing

Property Value
Create Documented, but on no path the client follows
Update Yes, update() on a reference
Delete Yes, delete() on a reference

Create attributes

Typed as People.WorkflowCategorySchema['create'].

Attribute Type
name string | null

Update attributes

Typed as People.WorkflowCategorySchema['update'].

Attribute Type
name string | null

See Writing data.

Example

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

const workflowId = '1'; // Workflow id

const page = await pco.people.workflows.id(workflowId).category.order('created_at').perPage(25).list();
const items: People.WorkflowCategory[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close