List

The endpoint to retrieve all buckets associated with the connected user or company.

Endpoint: /buckets/all
Method: GET

Headers

Authorization (required, string): Bearer token for authentication.

x-company-id (optional, string): If provided, returns buckets specific to that company. If omitted, returns the user's personal buckets.

Request Body

None

Example Request

GET /buckets/all
Content-Type: application/json
Authorization: Bearer <your_access_token>

Example Success Response (200 OK)

{
  "status": 200,
  "message": "Buckets retrieved successfully.",
  "data": [
    {
      "id": "bkt_user_001",
      "name": "Personal Documents",
      "type": "user",
      "storageUsed": "1.2GB",
      "fileCount": 150,
      "createdAt": "2024-01-10T08:00:00Z"
    },
    {
      "id": "bkt_comp_002",
      "name": "Project Alpha Assets",
      "type": "company",
      "storageUsed": "5.4GB",
      "fileCount": 340,
      "createdAt": "2024-02-15T10:30:00Z"
    }
  ]
}

Response Codes

200 OK: Buckets retrieved successfully.

401 Unauthorized: The current user is not authenticated.

500 Internal Server Error: Unexpected server error.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Headers

Request Body

Example Request

Example Success Response (200 OK)

Response Codes

Request

Request Code Samples

Responses

List

Headers#

Request Body#

Example Request#

Example Success Response (200 OK)#

Response Codes#

Request

Request Code Samples

Responses

Headers

Request Body

Example Request

Example Success Response (200 OK)

Response Codes