List

The endpoint to retrieve a list of folders within a specific bucket

Endpoint: /folders/findAll/{bucketId}
Method: GET

Path Parameters

bucketId (required, string): The unique identifier of the bucket to search within. Required for company

Query Parameters

searchTerm (optional, string): A keyword to filter folders by name.

page (optional, number, default: 1): The page number for pagination.

limit (optional, number, default: 10): The number of results per page.

orderBy (optional, string): The field to sort the results by (e.g., createdAt, name).

Example Request

GET /folders/findAll/bucket-123?searchTerm=Doc&page=1&limit=10&orderBy=createdAt
Content-Type: application/json

Example Success Response (200 OK)

{
  "success": 200,
  "message": "",
  "data": {
    "total": 15,
    "page": 1,
    "totalPages": 2,
    "limit": 10,
    "data": [
      {
        "id": "folder-abc123",
        "bucketId": "bucket-123",
        "parentId": null,
        "hashUrl": "unique-hash-abc123",
        "name": "Documents",
        "visibility": "private",
        "isDelete": false,
        "createdAt": "2024-01-15T10:30:00.000Z",
        "updatedAt": "2024-01-20T14:45:00.000Z",
        "deletedAt": null
      },
      {
        "id": "folder-def456",
        "bucketId": "bucket-123",
        "parentId": null,
        "hashUrl": "unique-hash-def456",
        "name": "Images",
        "visibility": "private",
        "isDelete": false,
        "createdAt": "2024-01-16T09:15:00.000Z",
        "updatedAt": "2024-01-16T09:15:00.000Z",
        "deletedAt": null
      }
    ]
  }
}

Response Codes

200 OK: Folders retrieved successfully.

400 Bad Request: Invalid query parameters.

401 Unauthorized: The current user is not authorized to access this bucket.

404 Not Found: The specified bucketId does not exist.

500 Internal Server Error: Unexpected server error.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

application/json

Body

Example

{
  "success": 200,
  "message": "",
  "data": {
    "total": 15,
    "page": 1,
    "totalPages": 2,
    "limit": 10,
    "data": [
      {
        "id": "folder-abc123",
        "bucketId": "bucket-123",
        "parentId": null,
        "hashUrl": "unique-hash-abc123",
        "name": "Documents",
        "visibility": "private",
        "isDelete": false,
        "createdAt": "2024-01-15T10:30:00.000Z",
        "updatedAt": "2024-01-20T14:45:00.000Z",
        "deletedAt": null
      },
      {
        "id": "folder-def456",
        "bucketId": "bucket-123",
        "parentId": null,
        "hashUrl": "unique-hash-def456",
        "name": "Images",
        "visibility": "private",
        "isDelete": false,
        "createdAt": "2024-01-16T09:15:00.000Z",
        "updatedAt": "2024-01-16T09:15:00.000Z",
        "deletedAt": null
      }
    ]
  }
}

Path Parameters

Query Parameters

Example Request

Example Success Response (200 OK)

Response Codes

Request

Request Code Samples

Responses

List

Path Parameters#

Query Parameters#

Example Request#

Example Success Response (200 OK)#

Response Codes#

Request

Request Code Samples

Responses

Path Parameters

Query Parameters

Example Request

Example Success Response (200 OK)

Response Codes