Skip to main content
GET
{documentURL}
/
internal
/
storage
/
buckets
/
{BUCKET_NAME}
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'
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.
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

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'

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();
⌘I