List Test Suites

List all test suites with optional filtering and pagination

GET /v1/dataQuality/testSuites

GET /v1/dataQuality/testSuites

Python

from metadata.sdk import configure
from metadata.sdk.entities import TestSuites

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# List first page
suites = TestSuites.list(limit=50)
for ts in suites.data:
    print(f"{ts.displayName} (executable: {ts.executable})")

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

# Filter by type
logical_suites = TestSuites.list(
    testSuiteType="logical",
    fields=["owners", "tests"],
    limit=50
)

for ts in logical_suites.data:
    print(f"{ts.displayName}")

Response

{
  "data": [
    {
      "id": "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
      "name": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
      "displayName": "Data Contract - dim_address_comprehensive_contract",
      "fullyQualifiedName": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
      "version": 0.1,
      "updatedAt": 1769982757893,
      "updatedBy": "admin",
      "deleted": false,
      "owners": [],
      "executable": true
    }
  ],
  "paging": {
    "after": "...",
    "total": 5
  }
}

List Test Suites

List all test suites 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, tests.

include · string · default: "non-deleted"

Include all, deleted, or non-deleted entities.

testSuiteType · string

Filter by test suite type: executable or logical.

GET /v1/dataQuality/testSuites

Python

from metadata.sdk import configure
from metadata.sdk.entities import TestSuites

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# List first page
suites = TestSuites.list(limit=50)
for ts in suites.data:
    print(f"{ts.displayName} (executable: {ts.executable})")

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

# Filter by type
logical_suites = TestSuites.list(
    testSuiteType="logical",
    fields=["owners", "tests"],
    limit=50
)

for ts in logical_suites.data:
    print(f"{ts.displayName}")

Response

{
  "data": [
    {
      "id": "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
      "name": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
      "displayName": "Data Contract - dim_address_comprehensive_contract",
      "fullyQualifiedName": "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
      "version": 0.1,
      "updatedAt": 1769982757893,
      "updatedBy": "admin",
      "deleted": false,
      "owners": [],
      "executable": true
    }
  ],
  "paging": {
    "after": "...",
    "total": 5
  }
}

---

Returns

Returns a paginated list of test suite objects. Use the fields parameter to request additional data.

Response

data · array

Array of test suite objects.

Show properties

id · string

Unique identifier for the test suite (UUID format).

name · string

Test suite name.

fullyQualifiedName · string

Fully qualified name of the test suite.

displayName · string

Human-readable display name.

executable · boolean

Whether this is an executable or logical test suite.

owners · array

List of owners. Only included when fields contains owners.

tests · array

List of test case references. Only included when fields contains tests.

paging · object

Pagination information.

Show properties

total · integer

Total count of test suites matching the query.

after · string

Cursor for the next page of results.

before · string

Cursor for the previous page of results.

---

Error Handling

Code	Error Type	Description
401	UNAUTHORIZED	Invalid or missing authentication token
403	FORBIDDEN	User lacks permission to list test suites