Skip to main content

Tags API

Manage taxonomy and tags for data product categorization.

Endpoints Overview

MethodEndpointDescription
GET/tagsList tags
POST/tagsCreate tag
GET/tags/{id}Get tag details
PATCH/tags/{id}Update tag
DELETE/tags/{id}Delete tag

List Tags

GET /tags

Query Parameters

ParameterTypeDescription
space_iduuidFilter by space
categorystringFilter by category

Response

{
"items": [
{
"id": "...",
"name": "Marketing",
"slug": "marketing",
"category": "domain",
"color": "#3b82f6",
"product_count": 15,
"created_at": "2025-01-01T00:00:00Z"
},
{
"id": "...",
"name": "PII",
"slug": "pii",
"category": "sensitivity",
"color": "#ef4444",
"product_count": 8,
"created_at": "2025-01-01T00:00:00Z"
}
]
}

Create Tag

POST /tags

Request Body

{
"name": "Finance",
"slug": "finance",
"category": "domain",
"color": "#10b981",
"space_id": "space-uuid"
}

Common Categories

CategoryDescription
domainBusiness domain (Marketing, Sales)
sensitivityData classification (PII, Confidential)
teamOwning team
statusLifecycle status
tierData tier (Bronze, Silver, Gold)

Update Tag

PATCH /tags/{id}
{
"name": "Sales & Marketing",
"color": "#8b5cf6"
}

Delete Tag

DELETE /tags/{id}
warning

Products with this tag will have it removed automatically.


Bulk Tag Operations

Add Tags to Product

PUT /catalog/spaces/{slug}/products/{id}/tags
{
"tag_ids": ["tag-1", "tag-2", "tag-3"]
}

This replaces all existing tags.

Add Single Tag

POST /catalog/spaces/{slug}/products/{id}/tags
{
"tag_id": "tag-uuid"
}

Appends to existing tags.

Remove Single Tag

DELETE /catalog/spaces/{slug}/products/{id}/tags/{tag_id}

Tag Usage Statistics

GET /tags/{id}/usage
{
"product_count": 15,
"products": [
{"id": "...", "name": "Customer Events"},
{"id": "...", "name": "Order Metrics"}
]
}