---
title: "WorkflowCard (People)"
description: "A Card"
---

> Documentation Index
> Fetch the complete documentation index at: https://planningcenterkit.mackenly.com/llms.txt
> Use this file to discover all available pages before exploring further.

# WorkflowCard (People)

A Card

| Property | Value |
| --- | --- |
| Product | [People](/reference/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](https://api.planningcenteronline.com/docs/apps/people/versions/2026-10-05/vertices/workflow_card) |

## 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](/guides/querying/); 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](/reference/people/workflow-step/) | Yes |
| `person` | To one | [Person](/reference/people/person/) | Yes |
| `workflow` | To one | [Workflow](/reference/people/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](/reference/people/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](/reference/people/workflow-card-activity/) | Collection |  | No |
| `ref.assignee` | [Person](/reference/people/person/) | Collection |  | No |
| `ref.current_step` | [WorkflowStep](/reference/people/workflow-step/) | Collection |  | No |
| `ref.notes` | [WorkflowCardNote](/reference/people/workflow-card-note/) | Collection |  | Yes |
| `ref.person` | [Person](/reference/people/person/) | Collection |  | No |
| `ref.workflow` | [Workflow](/reference/people/workflow/) | Collection |  | No |

## Writing

| Property | Value |
| --- | --- |
| Create | Yes, `create()` on `cards` on [Workflow](/reference/people/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](/guides/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

```ts
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;
```

Source: https://planningcenterkit.mackenly.com/reference/people/workflow-card/index.mdx
