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	User	Belongs to	user_id
parent	TagGroup	Belongs to	parent_id
children	TagGroup	Has many	tag_groups.parent_id
tags	Tag	Belongs to many	tag_tag_group.tag_group_id
taggableSections	TaggableSection	Has many	taggable_sections.default_tag_group_id
restrictedTaggableSections	TaggableSection	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

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/tags/groups/allowed/infoboard', [
    'headers' => ['Authorization' => "Bearer {accessToken}"]
]);

Example Response

[
  {
    "id": 31,
    "user_id": 7,
    "title": "Content type",
    "parent_id": null,
    "sort_number": 1,
    "created_at": "2026-08-06 09:00:00",
    "updated_at": "2026-08-06 09:00:00",
    "deleted_at": null
  },
  {
    "id": 32,
    "user_id": 19,
    "title": "Priority",
    "parent_id": 31,
    "sort_number": 2,
    "created_at": "2026-08-06 09:05:00",
    "updated_at": "2026-08-06 09:15:00",
    "deleted_at": null
  }
]

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

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/administration/tags/groups', [
    'headers' => ['Authorization' => 'Bearer {accessToken}'],
]);

Example Response

[
  {
    "id": 31,
    "user_id": 7,
    "title": "Content type",
    "parent_id": null,
    "sort_number": 1,
    "created_at": "2026-08-06 09:00:00",
    "updated_at": "2026-08-06 09:00:00",
    "deleted_at": null
  },
  {
    "id": 32,
    "user_id": 19,
    "title": "Priority",
    "parent_id": 31,
    "sort_number": 2,
    "created_at": "2026-08-06 09:05:00",
    "updated_at": "2026-08-06 09:15:00",
    "deleted_at": null
  }
]

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

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('GET', '/api/administration/tags/groups/31', [
    'headers' => ['Authorization' => 'Bearer {accessToken}'],
]);

Example Response

{
  "id": 31,
  "user_id": 7,
  "title": "Content type",
  "parent_id": null,
  "sort_number": 1,
  "created_at": "2026-08-06 09:00:00",
  "updated_at": "2026-08-06 09:00:00",
  "deleted_at": null
}

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

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('POST', '/api/administration/tags/groups', [
    'headers' => ['Authorization' => 'Bearer {accessToken}'],
    'json' => [
        'title' => 'Audience',
        'parent_id' => 31,
        'sort_number' => 3,
        'tag_ids' => [21, 22]
    ],
]);

Example Response

{
  "status": "success",
  "data": {
    "id": 33,
    "user_id": 7,
    "title": "Audience",
    "parent_id": 31,
    "sort_number": 3,
    "created_at": "2026-08-06 10:00:00",
    "updated_at": "2026-08-06 10:00:00",
    "deleted_at": null
  }
}

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

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('PUT', '/api/administration/tags/groups/33', [
    'headers' => ['Authorization' => 'Bearer {accessToken}'],
    'json' => [
        'sort_number' => 4,
        'tag_ids' => [21, 22, 25]
    ],
]);

Example Response

{
  "status": "success",
  "data": {
    "id": 33,
    "user_id": 7,
    "title": "Audience",
    "parent_id": 31,
    "sort_number": 4,
    "created_at": "2026-08-06 10:00:00",
    "updated_at": "2026-08-06 10:30:00",
    "deleted_at": null
  }
}

Admin: Delete

Delete an existing TagGroup.

Definition

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

Route Parameters

Parameter	Type	Description
tagGroup	integer	TagGroup ID.

Example Request

PHP

$client = new GuzzleHttp\Client(['base_uri' => 'https://{tenant}.intratool.de']);
$response = $client->request('DELETE', '/api/administration/tags/groups/33', [
    'headers' => ['Authorization' => 'Bearer {accessToken}'],
]);

Example Response

{
  "status": "success",
  "data": null
}