Skip to main content
GET
https://sandbox.getcollate.io/api
/
v1
/
tags
GET /v1/tags
from metadata.sdk import configure
from metadata.sdk.entities import Tags

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# List first page
tags = Tags.list(limit=50)
for t in tags.data:
    print(f"{t.fullyQualifiedName}")

# List all with auto-pagination
for t in Tags.list_all():
    print(f"{t.fullyQualifiedName}")

# Filter by classification
tags = Tags.list(
    parent="Certification",
    fields=["owners", "children"],
    limit=50
)

for t in tags.data:
    print(f"{t.fullyQualifiedName}")
    if t.style:
        print(f"  Color: {t.style.get('color')}")
{
  "data": [
    {
      "id": "68ec158c-5f5e-4277-8a19-5e9e0cd5294f",
      "name": "Bronze",
      "fullyQualifiedName": "Certification.Bronze",
      "description": "Bronze certified Data Asset.",
      "style": {
        "color": "#C08320"
      },
      "version": 0.1,
      "updatedAt": 1769982619666,
      "updatedBy": "admin",
      "classification": {
        "id": "06d90883-6be9-4f7e-9475-753f10a95e94",
        "type": "classification",
        "name": "Certification",
        "fullyQualifiedName": "Certification",
        "deleted": false
      },
      "deleted": false,
      "owners": [],
      "provider": "system",
      "mutuallyExclusive": false
    }
  ],
  "paging": {
    "after": "...",
    "total": 3
  }
}

List Tags

List all tags with optional filtering and pagination.

Query Parameters

parent
string
Filter by parent classification fully qualified name (e.g., Certification).
limit
integer
default:"10"
Maximum number of results to return (max: 1000000).
before
string
Cursor for backward pagination.
after
string
Cursor for forward pagination.
fields
string
Comma-separated list of fields to include: owners, children. See Supported Fields below.
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/tags
from metadata.sdk import configure
from metadata.sdk.entities import Tags

configure(
    host="https://your-company.getcollate.io/api",
    jwt_token="your-jwt-token"
)

# List first page
tags = Tags.list(limit=50)
for t in tags.data:
    print(f"{t.fullyQualifiedName}")

# List all with auto-pagination
for t in Tags.list_all():
    print(f"{t.fullyQualifiedName}")

# Filter by classification
tags = Tags.list(
    parent="Certification",
    fields=["owners", "children"],
    limit=50
)

for t in tags.data:
    print(f"{t.fullyQualifiedName}")
    if t.style:
        print(f"  Color: {t.style.get('color')}")
{
  "data": [
    {
      "id": "68ec158c-5f5e-4277-8a19-5e9e0cd5294f",
      "name": "Bronze",
      "fullyQualifiedName": "Certification.Bronze",
      "description": "Bronze certified Data Asset.",
      "style": {
        "color": "#C08320"
      },
      "version": 0.1,
      "updatedAt": 1769982619666,
      "updatedBy": "admin",
      "classification": {
        "id": "06d90883-6be9-4f7e-9475-753f10a95e94",
        "type": "classification",
        "name": "Certification",
        "fullyQualifiedName": "Certification",
        "deleted": false
      },
      "deleted": false,
      "owners": [],
      "provider": "system",
      "mutuallyExclusive": false
    }
  ],
  "paging": {
    "after": "...",
    "total": 3
  }
}

Returns

Returns a paginated list of tag objects. By default, only basic fields are included. Use the fields parameter to request additional data.

Response

data
array
Array of tag objects.
paging
object
Pagination information.

Supported Fields

FieldDescription
ownersOwner references (users and teams)
childrenChild tag references

Error Handling

CodeError TypeDescription
401UNAUTHORIZEDInvalid or missing authentication token
403FORBIDDENUser lacks permission to list tags