A tag belonging to a tag group.
| Property | Value |
|---|---|
| Product | Services (pco.services, API version 2018-11-01) |
| Resource type | Tag |
| TypeScript | Services.Tag, attributes Services.TagAttributes, schema Services.TagSchema |
| Planning Center path | /services/v2/media/{media_id}/tags |
| Planning Center docs | Tag |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.services.songs.id(songId).arrangements.id(arrangementId).tags |
Collection | No | |
pco.services.media.id(mediaId).tags |
Collection | No | |
pco.services.people.id(personId).tags |
Collection | No | |
pco.services.songs.id(songId).tags |
Collection | No | |
pco.services.tag_groups.id(tagGroupId).tags |
Collection | No | |
pco.services.service_types.id(serviceTypeId).team_positions.id(teamPositionId).tags |
Collection | No |
From a collection, .id(tagId) addresses one Tag: pco.services.media.id(mediaId).tags.id(tagId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Services.TagAttributes. Every resource also has id and type ('Tag') next to its attributes.
| Name | Type | Description |
|---|---|---|
name |
string | null |
Relationships and includes
Planning Center documents no includes for this resource.
| Relationship | Type | To | Includable |
|---|---|---|---|
tag_group |
To one | TagGroup | No |
Querying
No documented where fields.
No documented order fields.
Edges
This resource has no documented edges.
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Services } from '@mackenly/planningcenterkit';
const mediaId = '1'; // Media id
const page = await pco.services.media.id(mediaId).tags.perPage(25).list();
const items: Services.Tag[] = page.data;