> ## 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](https://docs.flowx.ai/6.x/docs/platform-deep-dive/integrations/consuming-flowx-from-external-apps.md).

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.

> [!NOTE]
>
> 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.

## Authentication

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

**Authorization** `string` *required*

Bearer token for API authentication. Format: `Bearer YOUR_API_TOKEN`

## URL Parameters

**documentURL** `string` *required*

The base URL of the document storage service where buckets are managed.

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

**internal** `string` *required*

Path segment indicating this is an internal API call within the document service. This distinguishes internal system operations from external public APIs.

**storage** `string` *required*

Path segment specifying that this endpoint operates on storage resources. This groups all storage-related operations under a common path.

**buckets** `string` *required*

Path segment identifying the storage resource type. This indicates operations on bucket-level resources.

**BUCKET\_NAME** `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`

## Headers

**Cache-Control** `string` (default: no-cache)

Cache control directive. Use `no-cache` to ensure fresh object listings, especially after recent uploads or deletions.

**Accept** `string` (default: */*)

Content type that the client can accept. Supports `*/*` for all types.

**Accept-Encoding** `string` (default: gzip, deflate, br)

Acceptable encoding methods for response compression. Supports `gzip, deflate, br`.

## Request examples

```bash cURL theme={"dark"}
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'
```

```javascript Node.js theme={"dark"}
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={"dark"}
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()
```


## Related topics

- [Listing stored files](https://docs.flowx.ai/6.x/docs/platform-deep-dive/core-extensions/content-management/documents-plugin/listing-stored-files.md)
- [FlowX.AI data architecture: which service uses which store](https://docs.flowx.ai/6.x/docs/platform-overview/data-architecture.md)
- [Migrate self-hosted FlowX.AI to the flowx-ai Helm chart](https://docs.flowx.ai/6.x/setup-guides/migrate-to-flowx-ai-helm-chart.md)
- [KB Enrichment setup](https://docs.flowx.ai/6.x/setup-guides/kb-enrichment.md)
- [Document Converter setup](https://docs.flowx.ai/6.x/setup-guides/document-converter-setup.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.