Skip to content

Tag (Groups)

Tags are used to filter groups.

Tags are used to filter groups. They can be organized into tag_groups.

Property Value
Product Groups (pco.groups, API version 2026-11-10)
Resource type Tag
TypeScript Groups.Tag, attributes Groups.TagAttributes, schema Groups.TagSchema
Planning Center path /groups/v2/groups/{group_id}/tags
Planning Center docs Tag

How to reach it

Client path Returns Filters Create
pco.groups.groups.id(groupId).tags Collection No
pco.groups.tag_groups.id(tagGroupId).tags Collection No

From a collection, .id(tagId) addresses one Tag: pco.groups.groups.id(groupId).tags.id(tagId). Collections support where, include, order, and pagination; single resources have get().

Attributes

On Groups.TagAttributes. Every resource also has id and type ('Tag') next to its attributes.

Name Type Description
name string | null The name of the tag
position number | null The position of the tag in relation to other tags

Relationships and includes

Planning Center documents no includes for this resource.

Relationship Type To Includable
tag_group To one TagGroup No

Querying

Where

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

Field Value type Operators
id string Equality only
name string Equality only

Order

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

Edges

Follow these from one Tag, ref = pco.groups.groups.id(groupId).tags.id(tagId):

Edge Leads to Returns Filters Create
ref.groups Group Collection No

Writing

Property Value
Create No
Update No
Delete No

Example

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

const groupId = '1'; // Group id

const page = await pco.groups.groups.id(groupId).tags.order('name').perPage(25).list();
const items: Groups.Tag[] = page.data;

Type to search…

↑↓ navigate↵ selectEsc close