> ## 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.

# Retrieve a Test Suite

> Get a test suite by ID or fully qualified name

# Retrieve a Test Suite

Get a single test suite by its unique ID or fully qualified name.

## Get by ID

<ParamField path="id" type="string" required>
  UUID of the test suite to retrieve.
</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>

## Get by Fully Qualified Name

Use `GET /v1/dataQuality/testSuites/name/{fqn}` to retrieve by fully qualified name.

<ParamField path="fqn" type="string" required>
  Fully qualified name of the test suite.
</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>

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

  # Get by ID
  ts = TestSuites.retrieve("e86a9a11-852f-4bac-b5a7-993b2bbbb572")
  print(f"{ts.displayName} (executable: {ts.executable})")

  # Get by ID with fields
  ts = TestSuites.retrieve(
      "e86a9a11-852f-4bac-b5a7-993b2bbbb572",
      fields=["owners", "tests"]
  )

  # Get by fully qualified name
  ts = TestSuites.retrieve_by_name("b5fcae09-02c2-4c0b-8c4a-5b52d650e592")
  ```

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

  // Get by ID
  var ts = TestSuites.retrieve("e86a9a11-852f-4bac-b5a7-993b2bbbb572");

  // Get by name with fields
  var ts = TestSuites.retrieveByName(
      "b5fcae09-02c2-4c0b-8c4a-5b52d650e592",
      "owners,tests"
  );
  ```

  ```bash GET /v1/dataQuality/testSuites/{id} theme={null}
  # Get by ID
  curl "{base_url}/api/v1/dataQuality/testSuites/e86a9a11-852f-4bac-b5a7-993b2bbbb572" \
    -H "Authorization: Bearer {access_token}"

  # Get by ID with fields
  curl "{base_url}/api/v1/dataQuality/testSuites/e86a9a11-852f-4bac-b5a7-993b2bbbb572?fields=owners,tests" \
    -H "Authorization: Bearer {access_token}"

  # Get by name
  curl "{base_url}/api/v1/dataQuality/testSuites/name/b5fcae09-02c2-4c0b-8c4a-5b52d650e592" \
    -H "Authorization: Bearer {access_token}"
  ```
</RequestExample>

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

***

## Returns

Returns a test suite object with all requested fields populated.

## Response

<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="description" type="string">
  Description of the test suite.
</ResponseField>

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

<ResponseField name="version" type="number">
  Version number for the entity.
</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>

***

## Error Handling

| Code  | Error Type     | Description                                    |
| ----- | -------------- | ---------------------------------------------- |
| `401` | `UNAUTHORIZED` | Invalid or missing authentication token        |
| `403` | `FORBIDDEN`    | User lacks permission to view this test suite  |
| `404` | `NOT_FOUND`    | Test suite with given ID or FQN does not exist |