List

Retrieves a paginated list of folders within a specific bucket, with optional filtering by folder name and sorting by a selected field. Use this endpoint when you need to browse or search folders that belong to a given bucket.

Method

GET /folders/findAll/{bucketId}

Request Body Parameters

This endpoint does not use a request body because it is a GET request. It accepts one path parameter and several query parameters.

Parameter	Location	Type	Required	Description
`bucketId`	Path	string	Yes	The unique identifier of the bucket to search within. Required for company context.
`searchTerm`	Query	string	No	A keyword used to filter folders by name.
`page`	Query	number	No	Page number for pagination. Default is `1`.
`limit`	Query	number	No	Number of results to return per page. Default is `10`.
`orderBy`	Query	string	No	Field used to sort the results, such as `createdAt` or `name`.

Example Request

{
  "method": "GET",
  "url": "/folders/findAll/bucket-123?searchTerm=Doc&page=1&limit=10&orderBy=createdAt",
  "headers": {
    "Content-Type": "application/json"
  }
}

Response Codes

200 OK — Folders retrieved successfully.

400 Bad Request — One or more query parameters are invalid.

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 — An unexpected server error occurred.

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
  "status": 200,
  "message": "Folder found successfully.",
  "data": {
    "total": 5,
    "page": 1,
    "totalPages": 1,
    "limit": 10,
    "data": [
      {
        "id": "uegxerbdayv4503dsdu6um7w",
        "bucketId": "rfmuc7uiqxadlvz1fnxmk8td",
        "parentId": null,
        "hashUrl": "yxv2BGs5XEiPBuxWMkJDJOnWUF0Ddq9TDZHt0mOefBk",
        "name": "Test",
        "visibility": "private",
        "isDelete": false,
        "createdAt": "2026-04-29T22:04:03.007Z",
        "updatedAt": "2026-04-30T15:55:30.786Z",
        "deletedAt": null,
        "hasSubfolders": true,
        "totalSubfolders": 2,
        "sharedUsersCount": 0,
        "sharedLink": null
      },
      {
        "id": "yx76k69to5pgvqq5dc9ubngq",
        "bucketId": "rfmuc7uiqxadlvz1fnxmk8td",
        "parentId": null,
        "hashUrl": "MoP1Iugh6I8c_R3iMlLWQG_jrEw04OqglgItNcRM2C8",
        "name": "Videos",
        "visibility": "private",
        "isDelete": false,
        "createdAt": "2026-04-30T15:59:08.316Z",
        "updatedAt": "2026-04-30T15:59:08.316Z",
        "deletedAt": null,
        "hasSubfolders": false,
        "totalSubfolders": 0,
        "sharedUsersCount": 0,
        "sharedLink": null
      },
      {
        "id": "h2718bcie3l428ck3rkhnjj4",
        "bucketId": "rfmuc7uiqxadlvz1fnxmk8td",
        "parentId": null,
        "hashUrl": "ko5j5wqvS66kTKS0nhFAsxyA-R9y5FLDE2FCV0PwU9I",
        "name": "Documents",
        "visibility": "private",
        "isDelete": false,
        "createdAt": "2026-05-12T12:46:50.773Z",
        "updatedAt": "2026-05-12T12:46:50.773Z",
        "deletedAt": null,
        "hasSubfolders": false,
        "totalSubfolders": 0,
        "sharedUsersCount": 0,
        "sharedLink": null
      },
      {
        "id": "beycwbmmvu2symytbmzh8r1f",
        "bucketId": "rfmuc7uiqxadlvz1fnxmk8td",
        "parentId": null,
        "hashUrl": "Dz8TN3-njuwPlNK9ew3JixESnn09OXuBHL98QXbs-Is",
        "name": "Projects Documents",
        "visibility": "private",
        "isDelete": false,
        "createdAt": "2026-05-12T12:49:52.620Z",
        "updatedAt": "2026-05-12T12:49:52.620Z",
        "deletedAt": null,
        "hasSubfolders": false,
        "totalSubfolders": 0,
        "sharedUsersCount": 0,
        "sharedLink": null
      },
      {
        "id": "udxzapr8wsndsxc09bc41qes",
        "bucketId": "rfmuc7uiqxadlvz1fnxmk8td",
        "parentId": null,
        "hashUrl": "C_pnyllDeVK1OhSOiHtrzuRSJb8urIRTvSyk-xUGZLY",
        "name": "Credia",
        "visibility": "private",
        "isDelete": false,
        "createdAt": "2026-05-12T12:55:00.534Z",
        "updatedAt": "2026-05-12T12:55:00.534Z",
        "deletedAt": null,
        "hasSubfolders": false,
        "totalSubfolders": 0,
        "sharedUsersCount": 0,
        "sharedLink": null
      }
    ]
  }
}

Method#

Request Body Parameters#

Response Codes#

Request

Request Code Samples

Responses

Method

Request Body Parameters

Response Codes