Skip to main content
GET
/
utils
/
metadata
/
tags
Get or list catalog tags
curl --request GET \
  --url https://api.example.com/utils/metadata/tags \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "fully_qualified_name": "<string>",
  "version": 123,
  "category_id": "<string>",
  "created_by": "<string>",
  "updated_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "asset_type": "tag",
  "description": "<string>",
  "owners": [
    {}
  ],
  "style": {
    "color": "<string>",
    "icon": "<string>"
  },
  "deleted_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
fqn
string | null

Fully qualified name for single tag retrieval

​
version
integer | null

Specific version to retrieve (only with fqn)

Required range: x >= 1
​
page
integer
default:1

Page number (starts at 1)

Required range: x >= 1
​
limit
integer
default:50

Items per page (max 200)

Required range: 1 <= x <= 200
​
fqn_prefix
string | null

Filter tags by category FQN prefix (e.g., 'PII')

​
q
string | null

Search in name and description

​
sort_by
string
default:name

Sort field ('name' or 'created_at')

​
sort_order
string
default:asc

Sort order ('asc' or 'desc')

Response

CatalogTagDetail (if fqn provided) or CatalogTagListResponse (if listing)

Full catalog tag representation.

​
id
string
required
​
name
string
required
​
fully_qualified_name
string
required
​
version
integer
required
​
category_id
string
required
​
created_by
string
required
​
updated_by
string
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
asset_type
string
default:tag
​
description
string | null
​
owners
Owners · object[] | null
​
style
TagStyle · object

Visual styling for a tag.

​
deleted_at
string<date-time> | null