A Workflow
| Property | Value |
|---|---|
| Product | People (pco.people, API version 2026-10-05) |
| Resource type | Workflow |
| TypeScript | People.Workflow, attributes People.WorkflowAttributes, schema People.WorkflowSchema |
| Planning Center path | /people/v2/workflows |
| Planning Center docs | Workflow |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.people.workflows |
Collection | archived, has_active_automations, has_my_cards, manage_cards_allowed, needs_attention, not_archived, only_deleted, recently_deleted, recently_viewed, unassigned, with_deleted, with_recoverable, with_steps |
Yes |
pco.people.people.id(personId).workflow_cards.id(workflowCardId).workflow |
Collection | No |
From a collection, .id(workflowId) addresses one Workflow: pco.people.workflows.id(workflowId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On People.WorkflowAttributes. Every resource also has id and type ('Workflow') next to its attributes.
| Name | Type | Description |
|---|---|---|
archived_at |
string | null |
|
campus_id |
number | null |
|
completed_card_count |
number | null |
|
created_at |
string | null |
|
deleted_at |
string | null |
|
my_due_soon_card_count |
number | null |
Only available when requested with the ?fields param |
my_overdue_card_count |
number | null |
Only available when requested with the ?fields param |
my_ready_card_count |
number | null |
|
name |
string | null |
|
recently_viewed |
boolean | null |
|
total_cards_count |
number | null |
|
total_overdue_card_count |
number | null |
|
total_ready_and_snoozed_card_count |
number | null |
|
total_ready_card_count |
number | null |
|
total_steps_count |
number | null |
|
total_unassigned_card_count |
number | null |
|
total_unassigned_steps_count |
number | null |
|
updated_at |
string | null |
|
workflow_category_id |
number | null |
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): category, shares, steps.
| Relationship | Type | To | Includable |
|---|---|---|---|
campus |
To one | Campus | No |
workflow_category |
To one | WorkflowCategory | No |
Querying
Where
where(field, value) for equality; where(field, op, value) with the operators listed.
| Field | Value type | Operators |
|---|---|---|
archived_at |
string | Date |
gt, gte, lt, lte |
campus_id |
string | number |
Equality only |
created_at |
string | Date |
gt, gte, lt, lte |
deleted_at |
string | Date |
gt, gte, lt, lte |
id |
string |
Equality only |
name |
string |
Equality only |
updated_at |
string | Date |
gt, gte, lt, lte |
workflow_category_id |
string | number |
Equality only |
Order
order(...) accepts these fields, ascending, or descending with a - prefix: active_automations_count, archived_at, campus_id, campus_name, created_at, deleted_at, my_ready_card_count, name, recently_viewed, total_overdue_card_count, total_ready_card_count, total_unassigned_card_count, updated_at, workflow_category_id, workflow_category_name.
Filters
filter(...) names depend on the edge you query through:
| Edge | Filters |
|---|---|
pco.people.workflows |
archived, has_active_automations, has_my_cards, manage_cards_allowed, needs_attention, not_archived, only_deleted, recently_deleted, recently_viewed, unassigned, with_deleted, with_recoverable, with_steps |
Edges
Follow these from one Workflow, ref = pco.people.workflows.id(workflowId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.cards |
WorkflowCard | Collection | Yes | |
ref.category |
WorkflowCategory | Collection | No | |
ref.shared_people |
Person | Collection | No | |
ref.shares |
WorkflowShare | Collection | Yes | |
ref.steps |
WorkflowStep | Collection | Yes |
Writing
| Property | Value |
|---|---|
| Create | Yes, create() on pco.people.workflows |
| Update | Yes, update() on a reference |
| Delete | Yes, delete() on a reference |
Create attributes
Typed as People.WorkflowSchema['create'].
| Attribute | Type |
|---|---|
campus_id |
number | null |
name |
string | null |
workflow_category_id |
number | null |
Update attributes
Typed as People.WorkflowSchema['update'].
| Attribute | Type |
|---|---|
campus_id |
number | null |
name |
string | null |
workflow_category_id |
number | null |
See Writing data.
Example
import type { People } from '@mackenly/planningcenterkit';
const page = await pco.people.workflows.order('active_automations_count').perPage(25).list();
const items: People.Workflow[] = page.data;