Skip to content

ItemAssignment (Services)

An assignment of a person or position to a plan item.

An assignment of a person or position to a plan item.

Property Value
Product Services (pco.services, API version 2018-11-01)
Resource type ItemAssignment
TypeScript Services.ItemAssignment, attributes Services.ItemAssignmentAttributes, schema Services.ItemAssignmentSchema
Planning Center path /services/v2/service_types/{service_type_id}/plans/{plan_id}/items/{item_id}/item_assignments
Planning Center docs ItemAssignment

How to reach it

Client path Returns Filters Create
pco.services.songs.id(songId).last_scheduled_item.id(itemId).item_assignments Collection Yes

From a collection, .id(itemAssignmentId) addresses one ItemAssignment: pco.services.songs.id(songId).last_scheduled_item.id(itemId).item_assignments.id(itemAssignmentId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Services.ItemAssignmentAttributes. Every resource also has id and type ('ItemAssignment') next to its attributes.

Name Type Description
assignable_type string | null Possible values: Person or TeamPosition.

Relationships and includes

Planning Center documents no includes for this resource.

Relationship Type To Includable
assignable To one Person No
item To one Item No
plan To one Plan No

Querying

No documented where fields.

No documented order fields.

Edges

This resource has no documented edges.

Writing

Property Value
Create Yes, create() on item_assignments on Item
Update No
Delete Yes, delete() on a reference

Create attributes

Typed as Services.ItemAssignmentSchema['create'].

Attribute Type
assignable_id string
assignable_type string | null

See Writing data.

Example

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

const songId = '1'; // Song id
const itemId = '1'; // Item id

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

Type to search…

↑↓ navigate↵ selectEsc close