For the complete documentation index, see llms.txt. This page is also available as Markdown.

TagGroups

Introduction

TagGroups are used to organize and group Tags within the system. They allow for hierarchical structuring of Tags, assignment of Tags to groups, and restriction of Tag usage in specific TaggableSections.

A TagGroup can have a parent group, child groups, and can be assigned to one or more TaggableSections.

Model Definition

Alias

tagGroup

Relations

Key
Relation
Type
Relation Field(s)

user

Belongs to

user_id

parent

Belongs to

parent_id

children

Has many

tag_groups.parent_id

tags

Belongs to many

tag_tag_group.tag_group_id

taggableSections

Has many

taggable_sections.default_tag_group_id

restrictedTaggableSections

Morph to many

taggable_section_restrictbale.restrictable_type, taggable_section_restrictbale.restrictable_id

List by Section

List visible TagGroups for one taggable section.

Definition

GET /api/tags/groups/allowed/{taggableSection}

Route Parameters

Parameter
Type
Description

taggableSection

string

Existing TaggableSection ID.

Request Keys

Key
Type
Default
Description

selects

string

All fields

Comma-separated fields to return.

relations

string

Default relations

Pipe-separated relations to include.

Example Request

Example Response

Admin: List

List all TagGroups in administration scope.

Definition

GET /api/administration/tags/groups

Request Keys

Key
Type
Default
Description

selects

string

All fields

Comma-separated fields to return.

relations

string

Default relations

Pipe-separated relations to include.

limit

integer

No limit

Maximum number of active and deleted groups.

Example Request

Example Response

Admin: Show

Show one TagGroup in administration scope.

Definition

GET /api/administration/tags/groups/{tagGroup}

Route Parameters

Parameter
Type
Description

tagGroup

integer

TagGroup ID; deleted groups are included.

Request Keys

Key
Type
Default
Description

selects

string

All fields

Comma-separated fields to return.

relations

string

Default relations

Pipe-separated relations to include.

Example Request

Example Response

Admin: Create

Create a new TagGroup.

Definition

POST /api/administration/tags/groups

Request Keys

Key
Type
Default
Description

title *

string

-

The name of the TagGroup.

parent_id

int

-

The ID of the parent TagGroup.

sort_number

integer

Current highest +1

The index of the TagGroup related to the parent TagGroup.

tag_ids

array

-

Array of Tag IDs to assign to this group.

Keys with * are required.

Example Request

Example Response

Admin: Update

Update an existing TagGroup.

Definition

PUT /api/administration/tags/groups/{tagGroup}

Route Parameters

Parameter
Type
Description

tagGroup

integer

TagGroup ID.

Request Keys

Key
Type
Default
Description

title

string

Current value

TagGroup title.

parent_id

integer | null

Current value

Parent TagGroup ID.

sort_number

integer

Current value

Sort order among siblings.

tag_ids

array | null

Current assignments

Tag IDs; null detaches all.

Example Request

Example Response

Admin: Delete

Delete an existing TagGroup.

Definition

DELETE /api/administration/tags/groups/{tagGroup}

Route Parameters

Parameter
Type
Description

tagGroup

integer

TagGroup ID.

Example Request

Example Response

Last updated