API documentation
    API documentation
    • Back to home
    • File
    • List
      GET
    • Detail
      GET
    • Upload
      PUT
    • Update
      PUT
    • Download
      GET
    • Delete
      DELETE
    • Public Download
      GET
    • Share file with user
      PUT
    • Move file
      POST
    • Copy file
      POST

      List

      GET
      https://api.everabyte.io/api/files/findAll/{bucketId}
      The endpoint to retrieve a list of files within a specific bucket.
      Endpoint: /files/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 files 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, sizeByte).

      Example Request#

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

      Example Success Response (200 OK)#

      {
  "success": 200,
  "message": "",
  "data": {
    "total": 25,
    "page": 1,
    "totalPages": 3,
    "limit": 10,
    "data": [
      {
        "id": "file-xyz789",
        "bucketId": "bucket-123",
        "hashName": "encrypted-hash-xyz789.pdf",
        "name": "document.pdf",
        "sizeByte": 1048576,
        "visibility": "private",
        "isRetention": false,
        "isDelete": false,
        "extFile": "pdf",
        "createdAt": "2024-01-15T10:30:00.000Z",
        "updatedAt": "2024-01-20T14:45:00.000Z",
        "retentionPeriod": null,
        "downloadUrl": "/api/files/download/file-xyz789",
        "sharedLink": {
          "viewUrl": "/api/files/shared/a3f7e9c21b4d8f6e...",
          "downloadUrl": "/api/files/download/shared/a3f7e9c21b4d8f6e...",
          "sharedHash": "a3f7e9c21b4d8f6e...",
          "requiresPassword": true,
          "canView": true,
          "canDownload": true,
          "isPublic": false,
          "expiresAt": "2024-12-31T23:59:59.000Z",
          "maxAccess": 100,
          "accessCount": 15,
          "remainingAccess": 85,
          "isExpired": false
        }
      },
      {
        "id": "file-abc456",
        "bucketId": "bucket-123",
        "hashName": "encrypted-hash-abc456.jpg",
        "name": "image.jpg",
        "sizeByte": 524288,
        "visibility": "public",
        "isRetention": true,
        "isDelete": false,
        "extFile": "jpg",
        "createdAt": "2024-01-16T09:15:00.000Z",
        "updatedAt": "2024-01-16T09:15:00.000Z",
        "retentionPeriod": "2025-01-16T09:15:00.000Z",
        "downloadUrl": "/api/files/download/file-abc456",
        "sharedLink": null
      }
    ]
  }
}

      Response Object Detail#

      data.data[].sharedLink: If a shared link exists for the file, this object contains its configuration and status:
      requiresPassword: Boolean indicating if the link is password protected.
      isExpired: Boolean indicating if the link has passed its expiration date.
      remainingAccess: Number of downloads/views remaining before the link becomes invalid.

      Response Codes#

      200 OK: Files 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.

      Request

      Authorization
      Provide your bearer token in the
      Authorization
      header when making requests to protected resources.
      Example:
      Authorization: Bearer ********************
      Path Params

      Request Code Samples

      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      Dart
      R
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location --request GET 'https://api.everabyte.io/api/files/findAll/' \
--header 'Authorization: Bearer <token>'

      Responses

      🟢200Success
      application/json
      Body

      Example
      {
  "success": 200,
  "message": "",
  "data": {
    "total": 25,
    "page": 1,
    "totalPages": 3,
    "limit": 10,
    "data": [
      {
        "id": "file-xyz789",
        "bucketId": "bucket-123",
        "hashName": "encrypted-hash-xyz789.pdf",
        "name": "document.pdf",
        "sizeByte": 1048576,
        "visibility": "private",
        "isRetention": false,
        "isDelete": false,
        "extFile": "pdf",
        "createdAt": "2024-01-15T10:30:00.000Z",
        "updatedAt": "2024-01-20T14:45:00.000Z",
        "retentionPeriod": null,
        "downloadUrl": "/api/files/download/file-xyz789",
        "sharedLink": {
          "viewUrl": "/api/files/shared/a3f7e9c21b4d8f6e...",
          "downloadUrl": "/api/files/download/shared/a3f7e9c21b4d8f6e...",
          "sharedHash": "a3f7e9c21b4d8f6e...",
          "requiresPassword": true,
          "canView": true,
          "canDownload": true,
          "isPublic": false,
          "expiresAt": "2024-12-31T23:59:59.000Z",
          "maxAccess": 100,
          "accessCount": 15,
          "remainingAccess": 85,
          "isExpired": false
        }
      },
      {
        "id": "file-abc456",
        "bucketId": "bucket-123",
        "hashName": "encrypted-hash-abc456.jpg",
        "name": "image.jpg",
        "sizeByte": 524288,
        "visibility": "public",
        "isRetention": true,
        "isDelete": false,
        "extFile": "jpg",
        "createdAt": "2024-01-16T09:15:00.000Z",
        "updatedAt": "2024-01-16T09:15:00.000Z",
        "retentionPeriod": "2025-01-16T09:15:00.000Z",
        "downloadUrl": "/api/files/download/file-abc456",
        "sharedLink": null
      }
    ]
  }
}
      Modified at 2025-12-12 21:31:42
      Next
      Detail
      Built with