A position within a team.
| Property | Value |
|---|---|
| Product | Services (pco.services, API version 2018-11-01) |
| Resource type | TeamPosition |
| TypeScript | Services.TeamPosition, attributes Services.TeamPositionAttributes, schema Services.TeamPositionSchema |
| Planning Center path | /services/v2/service_types/{service_type_id}/team_positions |
| Planning Center docs | TeamPosition |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.services.people.id(personId).person_team_position_assignments.id(personTeamPositionAssignmentId).team_position |
Collection | No | |
pco.services.service_types.id(serviceTypeId).team_positions |
Collection | No | |
pco.services.teams.id(teamId).team_positions |
Collection | No |
From a collection, .id(teamPositionId) addresses one TeamPosition: pco.services.service_types.id(serviceTypeId).team_positions.id(teamPositionId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Services.TeamPositionAttributes. Every resource also has id and type ('TeamPosition') next to its attributes.
| Name | Type | Description |
|---|---|---|
name |
string | null |
|
negative_tag_groups |
unknown[] | null |
If the Team is assigned via tags, these are Tags where the option “None” is specified. |
sequence |
number | null |
|
tag_groups |
unknown[] | null |
If the Team is assigned via tags, these are Tags where the option “Any” is specified. |
tags |
unknown[] | null |
If the Team is assigned via tags, these are specific Tags that are specified. |
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): tags, team.
| Relationship | Type | To | Includable |
|---|---|---|---|
attachment_types |
To many | AttachmentType | No |
tags |
To many | Tag | Yes |
team |
To one | Team | Yes |
Querying
No documented where fields.
Order
order(...) accepts these fields, ascending, or descending with a - prefix: name.
Edges
Follow these from one TeamPosition, ref = pco.services.service_types.id(serviceTypeId).team_positions.id(teamPositionId):
| Edge | Leads to | Returns | Filters | Create |
|---|---|---|---|---|
ref.person_team_position_assignments |
PersonTeamPositionAssignment | Collection | time_preference_options |
Yes |
ref.tags |
Tag | Collection | No | |
ref.team |
Team | Collection | No |
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Services } from '@mackenly/planningcenterkit';
const serviceTypeId = '1'; // ServiceType id
const page = await pco.services.service_types.id(serviceTypeId).team_positions.order('name').perPage(25).list();
const items: Services.TeamPosition[] = page.data;