---
title: "NeededPosition (Services)"
description: "An amount of unfilled positions needed within a team in a plan."
---

> 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.

# NeededPosition (Services)

An amount of unfilled positions needed within a team in a plan.

| Property | Value |
| --- | --- |
| Product | [Services](/reference/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](https://api.planningcenteronline.com/docs/apps/services/versions/2018-11-01/vertices/needed_position) |

## 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](/guides/querying/); 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](/reference/services/plan/) | No |
| `team` | To one | [Team](/reference/services/team/) | Yes |
| `time` | To one | [PlanTime](/reference/services/plan-time/) | Yes |
| `time_preference_option` | To one | [TimePreferenceOption](/reference/services/time-preference-option/) | 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)`:

| Edge | Leads to | Returns | Filters | Create |
| --- | --- | --- | --- | --- |
| `ref.team` | [Team](/reference/services/team/) | Collection |  | No |
| `ref.time` | [PlanTime](/reference/services/plan-time/) | Collection |  | No |

## Writing

| Property | Value |
| --- | --- |
| Create | Yes, `create()` on `needed_positions` on [Plan](/reference/services/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](/guides/writing-data/).

## Example

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

Source: https://planningcenterkit.mackenly.com/reference/services/needed-position/index.mdx
