Skip to main content
GET
/
utils
/
metadata
/
catalog-tag-categories
Get or list catalog tag categories
curl --request GET \
  --url https://api.example.com/utils/metadata/catalog-tag-categories \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "fully_qualified_name": "<string>",
  "organization_id": "<string>",
  "version": 123,
  "created_by": "<string>",
  "updated_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "asset_type": "catalog_tag_category",
  "description": "<string>",
  "category_type": "<string>",
  "mutually_exclusive": false,
  "owners": [
    {}
  ],
  "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 entity 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:20

Items per page

Required range: 1 <= x <= 100
​
search
string | null

Search in name and description

Response

CatalogTagCategoryDetail (if fqn provided) or CatalogTagCategoryListResponse (if listing)

Full catalog tag category representation.

​
id
string
required
​
name
string
required
​
fully_qualified_name
string
required
​
organization_id
string
required
​
version
integer
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:catalog_tag_category
​
description
string | null
​
category_type
string | null
​
mutually_exclusive
boolean
default:false
​
owners
Owners · object[] | null
​
deleted_at
string<date-time> | null