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

# List objects in a bucket

> Retrieve all objects stored within a specific storage bucket, including files, metadata, and access information

<Warning>
  **Reference under review.** The path of this endpoint (`/internal/storage/...`) indicates it is an internal document-plugin operation used between FlowX services, not a public integration API. For supported integration patterns, see [Consuming FlowX from external apps](/5.9/docs/platform-deep-dive/integrations/consuming-flowx-from-external-apps).
</Warning>

This endpoint retrieves a comprehensive list of all objects (files, documents, etc.) stored within a specific storage bucket. Use this endpoint to explore bucket contents, check file availability, and gather object metadata before performing download or management operations.

<Info>
  Objects within a bucket include all file types, documents, images, and any other data stored in the specified container. Each object includes metadata such as size, modification date, and access permissions.
</Info>

## Authentication

This endpoint requires Bearer Token authentication. Include your API token in the Authorization header.

<ParamField header="Authorization" type="string" required>
  Bearer token for API authentication. Format: `Bearer YOUR_API_TOKEN`
</ParamField>

## URL Parameters

<ParamField path="documentURL" type="string" required>
  The base URL of the document storage service where buckets are managed.

  **Example:** `https://document-service.your-domain.com`
</ParamField>

<ParamField path="internal" type="string" required>
  Path segment indicating this is an internal API call within the document service. This distinguishes internal system operations from external public APIs.
</ParamField>

<ParamField path="storage" type="string" required>
  Path segment specifying that this endpoint operates on storage resources. This groups all storage-related operations under a common path.
</ParamField>

<ParamField path="buckets" type="string" required>
  Path segment identifying the storage resource type. This indicates operations on bucket-level resources.
</ParamField>

<ParamField path="BUCKET_NAME" type="string" required>
  The unique identifier for the target storage bucket. This should match exactly with an existing bucket name from your organization.

  **Example:** `qualitance-dev-paperflow-1416`
</ParamField>

## Headers

<ParamField header="Cache-Control" type="string" default="no-cache">
  Cache control directive. Use `no-cache` to ensure fresh object listings, especially after recent uploads or deletions.
</ParamField>

<ParamField header="Accept" type="string" default="*/*">
  Content type that the client can accept. Supports `*/*` for all types.
</ParamField>

<ParamField header="Accept-Encoding" type="string" default="gzip, deflate, br">
  Acceptable encoding methods for response compression. Supports `gzip, deflate, br`.
</ParamField>

## Request examples

<RequestExample>
  ```bash cURL theme={"system"}
  curl -X GET '{{documentURL}}/internal/storage/buckets/qualitance-dev-paperflow-1416' \
    -H 'Authorization: Bearer YOUR_API_TOKEN' \
    -H 'Cache-Control: no-cache' \
    -H 'Accept: */*' \
    -H 'Accept-Encoding: gzip, deflate, br'
  ```
</RequestExample>

<CodeGroup>
  ```javascript Node.js theme={"system"}
  const bucketName = 'qualitance-dev-paperflow-1416';
  const response = await fetch(`{{documentURL}}/internal/storage/buckets/${bucketName}`, {
    method: 'GET',
    headers: {
      'Authorization': 'Bearer YOUR_API_TOKEN',
      'Cache-Control': 'no-cache',
      'Accept': '*/*'
    }
  });

  const objects = await response.json();
  ```

  ```python Python theme={"system"}
  import requests

  bucket_name = 'qualitance-dev-paperflow-1416'
  response = requests.get(
      f'{{documentURL}}/internal/storage/buckets/{bucket_name}',
      headers={
          'Authorization': 'Bearer YOUR_API_TOKEN',
          'Cache-Control': 'no-cache',
          'Accept': '*/*'
      }
  )

  objects = response.json()
  ```
</CodeGroup>


## Related topics

- [Listing stored files](/5.9/docs/platform-deep-dive/core-extensions/content-management/documents-plugin/listing-stored-files.md)
- [Data architecture](/5.9/docs/platform-overview/data-architecture.md)
- [AI Platform setup](/5.9/setup-guides/ai-platform-setup.md)
- [Collection](/5.9/docs/building-blocks/ui-designer/ui-component-types/collection/collection.md)
- [Update environment variables](/release-notes/v5.x/v5.1.x-lts/v5.1.0-october-2025/migrating-from-v4.7.x-to-5.1/environment-variables.md)