Skip to content

WorkflowShare (People)

A workflow share defines who can access a workflow.

A workflow share defines who can access a workflow.

Property Value
Product People (pco.people, API version 2026-10-05)
Resource type WorkflowShare
TypeScript People.WorkflowShare, attributes People.WorkflowShareAttributes, schema People.WorkflowShareSchema
Planning Center path /people/v2/people/{person_id}/workflow_shares
Planning Center docs WorkflowShare

How to reach it

Client path Returns Filters Create
pco.people.people.id(personId).workflow_shares Collection No
pco.people.workflows.id(workflowId).shares Collection Yes

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

Attributes

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

Name Type Description
group string | null Possible values: No Access, Viewer, Editor, or Manager
permission string | null Possible values: view, manage_cards, or manage
person_id number | null

Relationships and includes

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

Relationship Type To Includable
person To one Person Yes
workflow To one Workflow No

Querying

Where

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

Field Value type Operators
permission string Equality only

No documented order fields.

Edges

Follow these from one WorkflowShare, ref = pco.people.people.id(personId).workflow_shares.id(workflowShareId):

Edge Leads to Returns Filters Create
ref.person Person Collection No

Writing

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

Create attributes

Typed as People.WorkflowShareSchema['create'].

Attribute Type
group string | null
permission string | null
person_id number | null

Update attributes

Typed as People.WorkflowShareSchema['update'].

Attribute Type
group string | null
permission string | null

See Writing data.

Example

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

const personId = '1'; // Person id

const page = await pco.people.people.id(personId).workflow_shares.perPage(25).list();
const items: People.WorkflowShare[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close