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

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

# List first page
classifications = Classifications.list(limit=50)
for c in classifications.data:
    print(f"{c.fullyQualifiedName} (mutuallyExclusive: {c.mutuallyExclusive})")

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

# With fields
classifications = Classifications.list(
    fields=["owners"],
    limit=50
)
{
  "data": [
    {
      "id": "06d90883-6be9-4f7e-9475-753f10a95e94",
      "name": "Certification",
      "fullyQualifiedName": "Certification",
      "description": "Certifying Data Asset will provide the users with a clear idea of...",
      "version": 0.1,
      "updatedAt": 1769982619610,
      "updatedBy": "admin",
      "deleted": false,
      "owners": [],
      "provider": "system",
      "mutuallyExclusive": true
    }
  ],
  "paging": {
    "after": "...",
    "total": 5
  }
}

List Classifications

List all classifications with optional filtering and pagination.

Query Parameters

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. See Supported Fields below.
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/classifications
from metadata.sdk import configure
from metadata.sdk.entities import Classifications

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

# List first page
classifications = Classifications.list(limit=50)
for c in classifications.data:
    print(f"{c.fullyQualifiedName} (mutuallyExclusive: {c.mutuallyExclusive})")

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

# With fields
classifications = Classifications.list(
    fields=["owners"],
    limit=50
)
{
  "data": [
    {
      "id": "06d90883-6be9-4f7e-9475-753f10a95e94",
      "name": "Certification",
      "fullyQualifiedName": "Certification",
      "description": "Certifying Data Asset will provide the users with a clear idea of...",
      "version": 0.1,
      "updatedAt": 1769982619610,
      "updatedBy": "admin",
      "deleted": false,
      "owners": [],
      "provider": "system",
      "mutuallyExclusive": true
    }
  ],
  "paging": {
    "after": "...",
    "total": 5
  }
}

Returns

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

Response

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

Supported Fields

FieldDescription
ownersOwner references (users and teams)

Error Handling

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