An amount of unfilled positions needed within a team in a plan.
| Property | Value |
|---|---|
| Product | Services (pco.services, API version 2018-11-01) |
| Resource type | NeededPosition |
| TypeScript | Services.NeededPosition, attributes Services.NeededPositionAttributes, schema Services.NeededPositionSchema |
| Planning Center path | /services/v2/series/{series_id}/plans/{plan_id}/needed_positions |
| Planning Center docs | NeededPosition |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.services.series.id(seriesId).plans.id(planId).needed_positions |
Collection | Yes |
From a collection, .id(neededPositionId) addresses one NeededPosition: pco.services.series.id(seriesId).plans.id(planId).needed_positions.id(neededPositionId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Services.NeededPositionAttributes. Every resource also has id and type ('NeededPosition') next to its attributes.
| Name | Type | Description |
|---|---|---|
quantity |
number | null |
|
scheduled_to |
string | null |
|
team_position_name |
string | null |
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): team, time.
| Relationship | Type | To | Includable |
|---|---|---|---|
plan |
To one | Plan | No |
team |
To one | Team | Yes |
time |
To one | PlanTime | Yes |
time_preference_option |
To one | TimePreferenceOption | No |
Querying
No documented where fields.
No documented order fields.
Edges
Follow these from one NeededPosition, ref = pco.services.series.id(seriesId).plans.id(planId).needed_positions.id(neededPositionId):
Writing
| Property | Value |
|---|---|
| Create | Yes, create() on needed_positions on Plan |
| Update | Yes, update() on a reference |
| Delete | Yes, delete() on a reference |
Create attributes
Typed as Services.NeededPositionSchema['create'].
| Attribute | Type |
|---|---|
quantity |
number | null |
team_id |
string |
team_position_id |
string |
time_id |
string |
time_preference_option_id |
string |
Update attributes
Typed as Services.NeededPositionSchema['update'].
| Attribute | Type |
|---|---|
quantity |
number | null |
See Writing data.
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).needed_positions.perPage(25).list();
const items: Services.NeededPosition[] = page.data;