A tag group contains tags
| Property | Value |
|---|---|
| Product | Services (pco.services, API version 2018-11-01) |
| Resource type | TagGroup |
| TypeScript | Services.TagGroup, attributes Services.TagGroupAttributes, schema Services.TagGroupSchema |
| Planning Center path | /services/v2/tag_groups |
| Planning Center docs | TagGroup |
How to reach it
| Client path | Returns | Filters | Create |
|---|---|---|---|
pco.services.tag_groups |
Collection | arrangement, media, person, song |
No |
From a collection, .id(tagGroupId) addresses one TagGroup: pco.services.tag_groups.id(tagGroupId). Collections support where, include, order, and pagination; single resources have get().
Attributes
On Services.TagGroupAttributes. Every resource also has id and type ('TagGroup') next to its attributes.
| Name | Type | Description |
|---|---|---|
allow_multiple_selections |
boolean | null |
|
name |
string | null |
|
required |
boolean | null |
|
service_type_folder_name |
string | null |
|
tags_for |
string | null |
Scopes a tag group to person, song, arrangement, media |
Relationships and includes
Side-load with include() (or get({ include })) and read with related(resource, name): folder, tags.
Querying
Where
where(field, value) for equality; where(field, op, value) with the operators listed.
| Field | Value type | Operators |
|---|---|---|
name |
string |
Equality only |
tags_for |
string |
Equality only |
No documented order fields.
Filters
filter(...) names depend on the edge you query through:
| Edge | Filters |
|---|---|
pco.services.tag_groups |
arrangement, media, person, song |
Edges
Follow these from one TagGroup, ref = pco.services.tag_groups.id(tagGroupId):
Writing
| Property | Value |
|---|---|
| Create | No |
| Update | No |
| Delete | No |
Example
import type { Services } from '@mackenly/planningcenterkit';
const page = await pco.services.tag_groups.perPage(25).list();
const items: Services.TagGroup[] = page.data;