---
title: "Item (Services)"
description: "An item 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.

# Item (Services)

An item in a plan.

| Property | Value |
| --- | --- |
| Product | [Services](/reference/services/) (`pco.services`, API version `2018-11-01`) |
| Resource type | `Item` |
| TypeScript | `Services.Item`, attributes `Services.ItemAttributes`, schema `Services.ItemSchema` |
| Planning Center path | `/services/v2/service_types/{service_type_id}/plans/{plan_id}/items` |
| Planning Center docs | [Item](https://api.planningcenteronline.com/docs/apps/services/versions/2018-11-01/vertices/item) |

## How to reach it

| Client path | Returns | Filters | Create |
| --- | --- | --- | --- |
| `pco.services.series.id(seriesId).plans.id(planId).live.id(liveId).items` | Collection |  | No |
| `pco.services.series.id(seriesId).plans.id(planId).items` | Collection |  | Yes |
| `pco.services.service_types.id(serviceTypeId).plan_templates.id(planTemplateId).items` | Collection |  | Yes |
| `pco.services.songs.id(songId).last_scheduled_item` | Collection |  | No |

From a collection, `.id(itemId)` addresses one Item: `pco.services.songs.id(songId).last_scheduled_item.id(itemId)`. Collections support [`where`, `include`, `order`, and pagination](/guides/querying/); single resources have `get()`.

## Attributes

On `Services.ItemAttributes`. Every resource also has `id` and `type` (`'Item'`) next to its attributes.

| Name | Type | Description |
| --- | --- | --- |
| `created_at` | `string \| null` |  |
| `custom_arrangement_sequence` | `unknown[] \| null` | See [details](#custom-arrangement-sequence). |
| `custom_arrangement_sequence_full` | `unknown[] \| null` |  |
| `custom_arrangement_sequence_short` | `unknown[] \| null` |  |
| `description` | `string \| null` |  |
| `html_details` | `string \| null` |  |
| `item_type` | `string \| null` | See [details](#item-type). |
| `key_name` | `string \| null` |  |
| `length` | `number \| null` |  |
| `sequence` | `number \| null` |  |
| `service_position` | `string \| null` | See [details](#service-position). |
| `title` | `string \| null` |  |
| `updated_at` | `string \| null` |  |

### Attribute details

#### `custom_arrangement_sequence` {#custom-arrangement-sequence}

An array of strings containing a label and a number describing the section:

['Verse 1', 'Chorus 1', 'Verse 2']

#### `item_type` {#item-type}

There are 4 possible values:

- `song`: The item is a song

- `header`: The item is a header

- `media`: The item is a piece of media

- `item`: The default item type

This value can only be set when an item is created. The only value that you can pass is `header`. If no value is passed then `item` will be used. To create a media item you'll attach a video media to the item, and to create a song item, you'll attach a song.

#### `service_position` {#service-position}

There are 3 possible values:

- `pre`: the item happens before the service starts

- `post`: the item happens after the service ends

- `during`: the item happens during the service

## Relationships and includes

Side-load with `include()` (or `get({ include })`) and read with `related(resource, name)`: `arrangement`, `item_assignments`, `item_notes`, `item_times`, `key`, `media`, `selected_attachment`, `song`.

| Relationship | Type | To | Includable |
| --- | --- | --- | --- |
| `arrangement` | To one | [Arrangement](/reference/services/arrangement/) | Yes |
| `key` | To one | [Key](/reference/services/key/) | Yes |
| `plan` | To one | [Plan](/reference/services/plan/) | No |
| `selected_background` | To one | [Attachment](/reference/services/attachment/) | No |
| `selected_layout` | To one | `Layout` | No |
| `song` | To one | [Song](/reference/services/song/) | Yes |

## Querying

No documented `where` fields.

No documented `order` fields.

## Edges

Follow these from one Item, `ref = pco.services.songs.id(songId).last_scheduled_item.id(itemId)`:

| Edge | Leads to | Returns | Filters | Create |
| --- | --- | --- | --- | --- |
| `ref.arrangement` | [Arrangement](/reference/services/arrangement/) | Collection |  | No |
| `ref.attachments` | [Attachment](/reference/services/attachment/) | Collection |  | Yes |
| `ref.custom_slides` | [CustomSlide](/reference/services/custom-slide/) | Collection |  | Yes |
| `ref.item_assignments` | [ItemAssignment](/reference/services/item-assignment/) | Collection |  | Yes |
| `ref.item_notes` | [ItemNote](/reference/services/item-note/) | Collection |  | Yes |
| `ref.item_times` | [ItemTime](/reference/services/item-time/) | Collection |  | No |
| `ref.key` | [Key](/reference/services/key/) | Collection |  | No |
| `ref.media` | [Media](/reference/services/media/) | Collection |  | No |
| `ref.selected_attachment` | [Attachment](/reference/services/attachment/) | Collection |  | No |
| `ref.selected_background` | [Attachment](/reference/services/attachment/) | Collection |  | No |
| `ref.song` | [Song](/reference/services/song/) | Collection |  | No |

## Writing

| Property | Value |
| --- | --- |
| Create | Yes, `create()` on `items` on [Plan](/reference/services/plan/), `items` on [PlanTemplate](/reference/services/plan-template/) |
| Update | Yes, `update()` on a reference |
| Delete | Yes, `delete()` on a reference |

### Create attributes

Typed as `Services.ItemSchema['create']`.

| Attribute | Type |
| --- | --- |
| `arrangement_id` | `string` |
| `copy_item_id` | `string` |
| `custom_arrangement_sequence` | `unknown[] \| null` |
| `description` | `string \| null` |
| `html_details` | `string \| null` |
| `item_type` | `string \| null` |
| `key_id` | `string` |
| `length` | `number \| null` |
| `media_ids` | `string[]` |
| `selected_attachment_id` | `string` |
| `selected_background_id` | `string` |
| `selected_layout_id` | `string` |
| `sequence` | `number \| null` |
| `service_position` | `string \| null` |
| `song_id` | `string` |
| `title` | `string \| null` |

### Update attributes

Typed as `Services.ItemSchema['update']`.

| Attribute | Type |
| --- | --- |
| `arrangement_id` | `string` |
| `custom_arrangement_sequence` | `unknown[] \| null` |
| `description` | `string \| null` |
| `html_details` | `string \| null` |
| `key_id` | `string` |
| `length` | `number \| null` |
| `media_ids` | `string[]` |
| `selected_attachment_id` | `string` |
| `selected_background_id` | `string` |
| `selected_layout_id` | `string` |
| `service_position` | `string \| null` |
| `song_id` | `string` |
| `title` | `string \| null` |

See [Writing data](/guides/writing-data/).

## Example

```ts
import type { Services } from '@mackenly/planningcenterkit';

const songId = '1'; // Song id

const page = await pco.services.songs.id(songId).last_scheduled_item.perPage(25).list();
const items: Services.Item[] = page.data;
```

Source: https://planningcenterkit.mackenly.com/reference/services/item/index.mdx
