> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# List Test Suites

> List all test suites with optional filtering and pagination

# List Test Suites

List all test suites with optional filtering and pagination.

## Query Parameters

<ParamField query="limit" type="integer" default="10">
  Maximum number of results to return (max: 1000000).
</ParamField>

<ParamField query="before" type="string">
  Cursor for backward pagination.
</ParamField>

<ParamField query="after" type="string">
  Cursor for forward pagination.
</ParamField>

<ParamField query="fields" type="string">
  Comma-separated list of fields to include: `owners`, `tests`.
</ParamField>

<ParamField query="include" type="string" default="non-deleted">
  Include `all`, `deleted`, or `non-deleted` entities.
</ParamField>

<ParamField query="testSuiteType" type="string">
  Filter by test suite type: `executable` or `logical`.
</ParamField>

<RequestExample dropdown>
  ```python GET /v1/dataQuality/testSuites theme={null}
  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}")
  ```

  ```java GET /v1/dataQuality/testSuites theme={null}
  import static org.openmetadata.sdk.fluent.TestSuites.*;

  // List first page
  var result = TestSuites.list()
      .limit(50)
      .execute();

  for (var ts : result.getData()) {
      System.out.println(ts.getDisplayName());
  }

  // Filter by type
  var result = TestSuites.list()
      .testSuiteType("logical")
      .fields("owners", "tests")
      .limit(50)
      .execute();
  ```

  ```bash GET /v1/dataQuality/testSuites theme={null}
  # List all
  curl "{base_url}/api/v1/dataQuality/testSuites?limit=50" \
    -H "Authorization: Bearer {access_token}"

  # Filter by type
  curl "{base_url}/api/v1/dataQuality/testSuites?testSuiteType=executable&limit=50" \
    -H "Authorization: Bearer {access_token}"

  # With fields
  curl "{base_url}/api/v1/dataQuality/testSuites?fields=owners,tests&limit=50" \
    -H "Authorization: Bearer {access_token}"
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "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
    }
  }
  ```
</ResponseExample>

***

## Returns

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

## Response

<ResponseField name="data" type="array">
  Array of test suite objects.

  <Expandable title="properties">
    <ResponseField name="id" type="string">
      Unique identifier for the test suite (UUID format).
    </ResponseField>

    <ResponseField name="name" type="string">
      Test suite name.
    </ResponseField>

    <ResponseField name="fullyQualifiedName" type="string">
      Fully qualified name of the test suite.
    </ResponseField>

    <ResponseField name="displayName" type="string">
      Human-readable display name.
    </ResponseField>

    <ResponseField name="executable" type="boolean">
      Whether this is an executable or logical test suite.
    </ResponseField>

    <ResponseField name="owners" type="array" optional>
      List of owners. Only included when `fields` contains `owners`.
    </ResponseField>

    <ResponseField name="tests" type="array" optional>
      List of test case references. Only included when `fields` contains `tests`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="paging" type="object">
  Pagination information.

  <Expandable title="properties">
    <ResponseField name="total" type="integer">
      Total count of test suites matching the query.
    </ResponseField>

    <ResponseField name="after" type="string" optional>
      Cursor for the next page of results.
    </ResponseField>

    <ResponseField name="before" type="string" optional>
      Cursor for the previous page of results.
    </ResponseField>
  </Expandable>
</ResponseField>

***

## Error Handling

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