Creating and Organising Tags
Create a vocabulary first
Tags live inside vocabularies, so create the vocabulary before the tag.
- Go to /tags/vocabularies.
- Click New Vocabulary.
- Fill in:
- Name — what users see (e.g. "Priority").
- Key — URL-safe identifier used in API calls (e.g.
priority). - Scope —
WORKSPACEfor workspace-only,TENANTfor the whole tenant,GLOBALfor system-wide,PRIVATEfor personal use. - Cardinality —
SINGLEif an entity may only have one tag from this vocabulary;MULTIPLEif many. - Required — whether entities must have a tag from this vocabulary.
- Allow custom tags — whether end users can add new tags, or only the predefined set.
You need tag-vocabulary:create permission on the chosen scope.
Create a tag
- Go to /tags/new (or /tags/list → New Tag).
- Pick the vocabulary the tag belongs to.
- Fill in:
- Label — what users see (e.g. "Critical").
- Key — URL-safe identifier (e.g.
critical). - Description — optional explanation.
- Parent tag — optional, makes this tag a child of another tag for hierarchy.
- Color — optional, pick from the workspace palette.
- Icon — optional.
You need tag:create permission on the workspace.
Build a hierarchy
You can nest tags by setting a parent. Hierarchies are used for things like:
- Department → Engineering → Frontend
- Region → APAC → India
Hierarchical tags inherit upward when filtering — a search for "Engineering" finds entities tagged with any descendant such as "Frontend" or "Backend".
Edit and delete
Open a tag's detail page at /tags/:tagId. You can:
- Edit the label, description, color, icon, parent.
- Move the tag to a different parent.
- Merge two tags (combines their assignments).
- Delete the tag (soft-delete; assignments are removed).
Edits and deletes require tag:update and tag:delete permissions.
Translations
A tag can have translations for each locale your workspace supports. Open the
tag detail page → Translations tab → add a label/description for each
locale code (en, es, fr, de, ja, hi, zh).