Skip to content

WorkflowCardNote (People)

Workflow Note is a note that has been made on a Workflow Card

Workflow Note is a note that has been made on a Workflow Card

Property Value
Product People (pco.people, API version 2026-10-05)
Resource type WorkflowCardNote
TypeScript People.WorkflowCardNote, attributes People.WorkflowCardNoteAttributes, schema People.WorkflowCardNoteSchema
Planning Center path /people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/notes
Planning Center docs WorkflowCardNote

How to reach it

Client path Returns Filters Create
pco.people.people.id(personId).workflow_cards.id(workflowCardId).notes Collection Yes

From a collection, .id(workflowCardNoteId) addresses one WorkflowCardNote: pco.people.people.id(personId).workflow_cards.id(workflowCardId).notes.id(workflowCardNoteId). Collections support where, include, order, and pagination; single resources have get().

Attributes

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

Name Type Description
created_at string | null
note 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
updated_at string | Date gt, gte, lt, lte

Order

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

Edges

This resource has no documented edges.

Writing

Property Value
Create Yes, create() on notes on WorkflowCard
Update No
Delete No

Create attributes

Typed as People.WorkflowCardNoteSchema['create'].

Attribute Type
note string | null
note_category_id string

See Writing data.

Example

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

const personId = '1'; // Person id
const workflowCardId = '1'; // WorkflowCard id

const page = await pco.people.people.id(personId).workflow_cards.id(workflowCardId).notes.order('created_at').perPage(25).list();
const items: People.WorkflowCardNote[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close