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

> List all containers with optional filtering and pagination

# List Containers

List all containers with optional filtering and pagination.

## Query Parameters

<ParamField query="service" type="string">
  Filter by storage service fully qualified name.
</ParamField>

<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`, `tags`, `followers`, `votes`, `extension`, `domains`, `dataModel`, `children`, `sourceHash`. See [Supported Fields](#supported-fields) below.
</ParamField>

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

<RequestExample dropdown>
  ```python GET /v1/containers theme={null}
  from metadata.sdk import configure
  from metadata.sdk.entities import Containers

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

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

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

  # Filter by storage service
  containers = Containers.list(
      service="s3_datalake",
      fields=["owners", "tags", "dataModel"],
      limit=50
  )

  for c in containers.data:
      print(f"{c.fullyQualifiedName}")
      if c.owners:
          print(f"  Owners: {[o.name for o in c.owners]}")
      if c.tags:
          print(f"  Tags: {[t.tagFQN for t in c.tags]}")
  ```

  ```java GET /v1/containers theme={null}
  import static org.openmetadata.sdk.fluent.Containers.*;

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

  for (var c : result.getData()) {
      System.out.println(c.getFullyQualifiedName());
  }

  // Filter by storage service with fields
  var result = Containers.list()
      .service("s3_datalake")
      .fields("owners", "tags", "dataModel")
      .limit(50)
      .execute();

  for (var c : result.getData()) {
      System.out.println(c.getFullyQualifiedName());
  }
  ```

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

  # Filter by storage service
  curl "{base_url}/api/v1/containers?service=s3_datalake&limit=50" \
    -H "Authorization: Bearer {access_token}"

  # With fields
  curl "{base_url}/api/v1/containers?service=s3_datalake&fields=owners,tags,dataModel,children&limit=50" \
    -H "Authorization: Bearer {access_token}"
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
    "data": [
      {
        "id": "14744329-85c2-499e-b1fa-249fb8162341",
        "name": "analytics-bucket",
        "displayName": "Analytics Bucket",
        "fullyQualifiedName": "s3_datalake.analytics-bucket",
        "description": "Primary analytics data lake bucket",
        "version": 0.1,
        "updatedAt": 1769982673032,
        "updatedBy": "admin",
        "service": {
          "id": "d1589e1d-2ab0-431c-a383-15e4be20a106",
          "type": "storageService",
          "name": "s3_datalake",
          "fullyQualifiedName": "s3_datalake",
          "deleted": false
        },
        "serviceType": "S3",
        "prefix": "/analytics/",
        "numberOfObjects": 150000,
        "size": 5368709120,
        "fileFormats": ["parquet", "json"],
        "href": "http://localhost:8585/api/v1/containers/14744329-85c2-499e-b1fa-249fb8162341",
        "deleted": false,
        "owners": [],
        "tags": [],
        "followers": [],
        "votes": {
          "upVotes": 0,
          "downVotes": 0
        },
        "domains": []
      }
    ],
    "paging": {
      "after": "...",
      "total": 5
    }
  }
  ```
</ResponseExample>

***

## Returns

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

## Response

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

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

    <ResponseField name="name" type="string">
      Container name.
    </ResponseField>

    <ResponseField name="fullyQualifiedName" type="string">
      Fully qualified name in format `service.containerName`.
    </ResponseField>

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

    <ResponseField name="service" type="object">
      Reference to the parent storage service.
    </ResponseField>

    <ResponseField name="serviceType" type="string">
      Type of storage service (e.g., S3, GCS, ADLS, CustomStorage).
    </ResponseField>

    <ResponseField name="prefix" type="string" optional>
      Path prefix for objects in the container.
    </ResponseField>

    <ResponseField name="numberOfObjects" type="number" optional>
      Number of objects stored in the container.
    </ResponseField>

    <ResponseField name="size" type="number" optional>
      Total size of the container in bytes.
    </ResponseField>

    <ResponseField name="fileFormats" type="array" optional>
      List of file formats stored in the container.
    </ResponseField>

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

    <ResponseField name="tags" type="array" optional>
      Classification tags applied. Only included when `fields` contains `tags`.
    </ResponseField>

    <ResponseField name="domains" type="array" optional>
      Domain assignments for governance. Only included when `fields` contains `domains`.
    </ResponseField>

    <ResponseField name="followers" type="array" optional>
      Users following this container. Only included when `fields` contains `followers`.
    </ResponseField>

    <ResponseField name="votes" type="object" optional>
      User votes and ratings. Only included when `fields` contains `votes`.
    </ResponseField>

    <ResponseField name="dataModel" type="object" optional>
      Data model describing the schema of files. Only included when `fields` contains `dataModel`.
    </ResponseField>

    <ResponseField name="children" type="array" optional>
      Nested child containers. Only included when `fields` contains `children`.
    </ResponseField>

    <ResponseField name="extension" type="object" optional>
      Custom properties. Only included when `fields` contains `extension`.
    </ResponseField>
  </Expandable>
</ResponseField>

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

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

    <ResponseField name="after" type="string" optional>
      Cursor for the next page of results. Null if this is the last page.
    </ResponseField>

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

***

## Supported Fields

The following fields can be requested via the `fields` query parameter:

| Field        | Description                        |
| ------------ | ---------------------------------- |
| `owners`     | Owner references (users and teams) |
| `tags`       | Classification tags                |
| `followers`  | Users following the container      |
| `votes`      | User votes and ratings             |
| `extension`  | Custom property values             |
| `domains`    | Domain assignments for governance  |
| `dataModel`  | Data model with column definitions |
| `children`   | Nested child containers            |
| `sourceHash` | Hash for change detection          |

***

## Error Handling

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