Skip to content

TagGroup (Calendar)

A grouping of tags for organizational purposes.

A grouping of tags for organizational purposes.

Property Value
Product Calendar (pco.calendar, API version 2026-06-22)
Resource type TagGroup
TypeScript Calendar.TagGroup, attributes Calendar.TagGroupAttributes, schema Calendar.TagGroupSchema
Planning Center path /calendar/v2/tag_groups
Planning Center docs TagGroup

How to reach it

Client path Returns Filters Create
pco.calendar.tag_groups Collection required Yes
pco.calendar.tags.id(tagId).tag_group Collection No

From a collection, .id(tagGroupId) addresses one TagGroup: pco.calendar.tag_groups.id(tagGroupId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Calendar.TagGroupAttributes. Every resource also has id and type ('TagGroup') next to its attributes.

Name Type Description
created_at string | null UTC time at which the tag group was created
name string | null The name of the tag group
required boolean | null See details.
updated_at string | null UTC time at which the tag group was updated

Attribute details

required

  • true indicates tag from this tag group must be applied when creating an event

Relationships and includes

Side-load with include() (or get({ include })) and read with related(resource, name): events, tags.

Querying

Where

where(field, value) for equality; where(field, op, value) with the operators listed.

Field Value type Operators
created_at string | Date gt, gte, lt, lte
name string Equality only
updated_at string | Date gt, gte, lt, lte

Order

order(...) accepts these fields, ascending, or descending with a - prefix: name.

Filters

filter(...) names depend on the edge you query through:

Edge Filters
pco.calendar.tag_groups required

Edges

Follow these from one TagGroup, ref = pco.calendar.tag_groups.id(tagGroupId):

Edge Leads to Returns Filters Create
ref.events Event Collection No
ref.tags Tag Collection No

Writing

Property Value
Create Yes, create() on pco.calendar.tag_groups
Update Yes, update() on a reference
Delete Yes, delete() on a reference

Create attributes

Typed as Calendar.TagGroupSchema['create'].

Attribute Type
name string | null
required boolean | null

Update attributes

Typed as Calendar.TagGroupSchema['update'].

Attribute Type
name string | null
required boolean | null

See Writing data.

Example

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

const page = await pco.calendar.tag_groups.order('name').perPage(25).list();
const items: Calendar.TagGroup[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close