A Step
| Property | Value |
|---|---|
| Product | People (pco.people, API version 2026-10-05) |
| Resource type | WorkflowStep |
| TypeScript | People.WorkflowStep, attributes People.WorkflowStepAttributes, schema People.WorkflowStepSchema |
| Planning Center path | /people/v2/workflows/{workflow_id}/steps |
| Planning Center docs | WorkflowStep |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.people.workflows.id(workflowId).steps |
Collection | Yes | |
pco.people.people.id(personId).workflow_cards.id(workflowCardId).current_step |
Collection | No |
From a collection, .id(workflowStepId) addresses one WorkflowStep: pco.people.workflows.id(workflowId).steps.id(workflowStepId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On People.WorkflowStepAttributes. Every resource also has id and type ('WorkflowStep') next to its attributes.
| Name | Type | Description |
|---|---|---|
action_type |
string | null |
Possible values: assign or automate |
auto_snooze_days |
number | null |
|
auto_snooze_entry_hour |
number | null |
Valid values are 17-23. When set, only cards arriving after this hour are snoozed. Requires auto_snooze_value, auto_snooze_interval, and auto_snooze_wake_hour (which must be before it). |
auto_snooze_interval |
string | null |
See details. |
auto_snooze_value |
number | null |
Must be a positive number. When auto_snooze_entry_hour is set, this is not the snooze length. The card wakes at auto_snooze_wake_hour, and this duration adds only whole days beyond that. |
auto_snooze_wake_hour |
number | null |
Valid values are 7-19, defaulting to 7 when not set. The hour of day cards snooze until. Only present when auto-snooze is enabled (auto_snooze_value and auto_snooze_interval are set). |
created_at |
string | null |
|
default_assignee_id |
string | null |
|
description |
string | null |
|
expected_response_time_in_days |
number | null |
|
my_ready_card_count |
number | null |
|
name |
string | null |
|
sequence |
number | null |
|
skip_conditions_enabled |
boolean | null |
|
total_ready_card_count |
number | null |
|
updated_at |
string | null |
Attribute details
auto_snooze_interval
Valid values are day, week, or month. When auto_snooze_entry_hour is set, this is not the snooze length. The card wakes at auto_snooze_wake_hour, and this duration adds only whole days beyond that.
Possible values: day, week, or month
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): default_assignee.
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, sequence, updated_at.
Edges
Follow these from one WorkflowStep, ref = pco.people.workflows.id(workflowId).steps.id(workflowStepId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.assignee_summaries |
WorkflowStepAssigneeSummary | Collection | No | |
ref.default_assignee |
Person | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | Yes, create() on steps on Workflow |
| Update | Yes, update() on a reference |
| Delete | Yes, delete() on a reference |
Create attributes
Typed as People.WorkflowStepSchema['create'].
| Attribute | Type |
|---|---|
action_type |
string | null |
auto_snooze_entry_hour |
number | null |
auto_snooze_interval |
string | null |
auto_snooze_value |
number | null |
auto_snooze_wake_hour |
number | null |
default_assignee_id |
string | null |
description |
string | null |
expected_response_time_in_days |
number | null |
name |
string | null |
sequence |
number | null |
skip_conditions_enabled |
boolean | null |
Update attributes
Typed as People.WorkflowStepSchema['update'].
| Attribute | Type |
|---|---|
action_type |
string | null |
auto_snooze_entry_hour |
number | null |
auto_snooze_interval |
string | null |
auto_snooze_value |
number | null |
auto_snooze_wake_hour |
number | null |
default_assignee_id |
string | null |
description |
string | null |
expected_response_time_in_days |
number | null |
name |
string | null |
sequence |
number | null |
skip_conditions_enabled |
boolean | null |
See Writing data.
Example
import type { People } from '@mackenly/planningcenterkit';
const workflowId = '1'; // Workflow id
const page = await pco.people.workflows.id(workflowId).steps.order('created_at').perPage(25).list();
const items: People.WorkflowStep[] = page.data;