A Contributor Resource
| Property | Value |
|---|---|
| Product | Services (pco.services, API version 2018-11-01) |
| Resource type | Contributor |
| TypeScript | Services.Contributor, attributes Services.ContributorAttributes, schema Services.ContributorSchema |
| Planning Center path | /services/v2/series/{series_id}/plans/{plan_id}/contributors |
| Planning Center docs | Contributor |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.services.series.id(seriesId).plans.id(planId).contributors |
Collection | No |
From a collection, .id(contributorId) addresses one Contributor: pco.services.series.id(seriesId).plans.id(planId).contributors.id(contributorId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Services.ContributorAttributes. Every resource also has id and type ('Contributor') next to its attributes.
| Name | Type | Description |
|---|---|---|
contributable_action |
string | null |
|
contributable_category |
string | null |
|
contributable_type |
string | null |
|
created_at |
string | null |
|
full_name |
string | null |
|
photo_thumbnail_url |
string | null |
|
updated_at |
string | null |
Relationships and includes
Planning Center documents no includes for this resource.
Querying
No documented where fields.
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 | No |
| Update | No |
| Delete | No |
Example
import type { Services } from '@mackenly/planningcenterkit';
const seriesId = '1'; // Series id
const planId = '1'; // Plan id
const page = await pco.services.series.id(seriesId).plans.id(planId).contributors.order('created_at').perPage(25).list();
const items: Services.Contributor[] = page.data;