Skip to content

WorkflowCard (People)

A Card

A Card

Property Value
Product People (pco.people, API version 2026-10-05)
Resource type WorkflowCard
TypeScript People.WorkflowCard, attributes People.WorkflowCardAttributes, schema People.WorkflowCardSchema
Planning Center path /people/v2/people/{person_id}/workflow_cards
Planning Center docs WorkflowCard

How to reach it

Client path Returns Filters Create
pco.people.people.id(personId).workflow_cards Collection assigned No
pco.people.workflows.id(workflowId).cards Collection Yes

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

Attributes

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

Name Type Description
awaiting_automation boolean | null
calculated_due_at string | null
calculated_due_at_in_days_ago number | null
completed_at string | null
created_at string | null
flagged_for_notification_at string | null
moved_to_step_at string | null
overdue boolean | null
pending_skip_evaluation boolean | null
removed_at string | null
snooze_until string | null
stage string | null
sticky_assignment boolean | null
updated_at string | null

Relationships and includes

Side-load with include() (or get({ include })) and read with related(resource, name): assignee, current_step, person, workflow.

Relationship Type To Includable
assignee To one Assignee Yes
current_step To one WorkflowStep Yes
person To one Person Yes
workflow To one Workflow Yes

Querying

Where

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

Field Value type Operators
assignee_id string | number Equality only
overdue boolean Equality only
stage string Equality only

Order

order(...) accepts these fields, ascending, or descending with a - prefix: completed_at, created_at, first_name, flagged_for_notification_at, last_name, moved_to_step_at, removed_at, stage, updated_at.

Filters

filter(...) names depend on the edge you query through:

Edge Filters
workflow_cards on Person assigned

Edges

Follow these from one WorkflowCard, ref = pco.people.people.id(personId).workflow_cards.id(workflowCardId):

Edge Leads to Returns Filters Create
ref.activities WorkflowCardActivity Collection No
ref.assignee Person Collection No
ref.current_step WorkflowStep Collection No
ref.notes WorkflowCardNote Collection Yes
ref.person Person Collection No
ref.workflow Workflow Collection No

Writing

Property Value
Create Yes, create() on cards on Workflow
Update Yes, update() on a reference
Delete Yes, delete() on a reference

Create attributes

Typed as People.WorkflowCardSchema['create'].

Attribute Type
assignee_id string
person_id string
sticky_assignment boolean | null

Update attributes

Typed as People.WorkflowCardSchema['update'].

Attribute Type
assignee_id string
person_id string
sticky_assignment boolean | null

See Writing data.

Actions

Run with ref.action(name, body?). Bodies are untyped: see Planning Center’s docs for each action.

Action Path Description
go_back POST /people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/go_back Move a Workflow Card back to the previous step.
promote POST /people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/promote Move a Workflow Card to the next step.
remove POST /people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/remove Removes a card
restore POST /people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/restore Restore a card
send_email POST /people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/send_email Sends an email to the subject of the card
skip_step POST /people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/skip_step Move a Workflow Card to the next step without completing the current step.
snooze POST /people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/snooze Snoozes a card for a specific duration
unsnooze POST /people/v2/people/{person_id}/workflow_cards/{workflow_card_id}/unsnooze Unsnoozes a card

Example

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

const personId = '1'; // Person id

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

Type to search…

↑↓ navigate↵ selectEsc close