/api/server/folder/{id}

Fetch a folder by ID/name. Behavior varies based on public and allowUploads flags.

GET/api/server/folder/{id}

Path Parameters

id*string

Query Parameters

page?number

perpage?number

Default15

sortBy?string

Default"createdAt"

order?string

Default"desc"

Value in"asc" | "desc"

Response Body

`application/json`

{
  "folder": {
    "id": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "name": "string",
    "public": true,
    "allowUploads": true,
    "parentId": "string",
    "userId": "string",
    "files": [
      {
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "deletesAt": "2019-08-24T14:15:22Z",
        "favorite": true,
        "id": "string",
        "originalName": "string",
        "name": "string",
        "size": 0,
        "type": "string",
        "views": 0,
        "maxViews": 0,
        "password": "string",
        "folderId": "string",
        "anonymous": true,
        "thumbnail": {
          "path": "string"
        },
        "tags": [
          {
            "id": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "color": "string",
            "files": [
              {
                "id": "string"
              }
            ]
          }
        ],
        "url": "string",
        "similarity": 0
      }
    ],
    "parent": null,
    "children": [
      null
    ],
    "_count": {
      "children": 0,
      "files": 0
    }
  },
  "page": [
    {
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "deletesAt": "2019-08-24T14:15:22Z",
      "favorite": true,
      "id": "string",
      "originalName": "string",
      "name": "string",
      "size": 0,
      "type": "string",
      "views": 0,
      "maxViews": 0,
      "password": "string",
      "folderId": "string",
      "anonymous": true,
      "thumbnail": {
        "path": "string"
      },
      "tags": [
        {
          "id": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "name": "string",
          "color": "string",
          "files": [
            {
              "id": "string"
            }
          ]
        }
      ],
      "url": "string",
      "similarity": 0
    }
  ],
  "total": 0,
  "pages": 0
}

{
  "error": "E1000: Invalid request schema",
  "code": 1000,
  "statusCode": 400
}

/api/server/folder/{id}

Path Parameters

Query Parameters

Response Body

200application/json

4xxapplication/json

E1000: Invalid request schema

E1001: Invalid upload options

E1002: Invalid partial upload

E1003: Partial upload identifier is invalid

E1004: Partial upload was not detected

E1005: Partial uploads only support one file field

E1006: File extension is not allowed

E1007: Invalid characters in filename

E1008: Invalid characters in original filename

E1009: Invalid filename

E1010: Unrecognized file mimetype

E1011: File already in folder

E1012: File not in folder

E1013: File ID is required

E1014: File with this name already exists

E1015: A folder cannot be its own parent

E1016: Cannot move folder into one of its descendants

E1019: Invalid action

E1020: Cannot PATCH without an action

E1021: Cannot delete current session, use log out instead.

E1022: Invalid settings update

E1023: Invalid setup, no settings found. Run the setup process again before exporting data.

E1024: Export is not completed

E1025: No files to export

E1026: No files found for the given request

E1027: No files were deleted.

E1028: No files were updated.

E1029: No ID provided

E1030: No providers to delete

E1031: Session not found in logged in sessions

E1032: Invalid tag specified

E1033: Cannot create tag with the same name

E1034: Tag name already exists

E1035: Invalid invite code

E1036: Invites aren't enabled

E1037: User registration is disabled

E1038: Username already exists

E1039: Username is taken

E1040: A user with this username already exists

E1041: Vanity already exists

E1042: Vanity already taken

E1043: You can't delete your last OAuth provider without a password

E1044: Invalid username or password

E1045: Invalid code

E1046: Missing WebAuthn challenge ID

E1047: Missing WebAuthn payload

E1048: Passkey registration timed out, try again later

E1049: Error verifying passkey registration

E1050: Could not verify passkey registration

E1051: Error verifying passkey authentication

E1052: Could not verify passkey authentication

E1053: You don't have TOTP enabled

E1054: TOTP is disabled

E1055: Password must be a string

E1056: The 'maxBytes' value is required

E1057: The 'maxFiles' value is required

E1058: From date must be before to date

E1059: From date must be in the past

E1060: Passkey has legacy registration data and cannot be used

E1061: Invalid multipart/form-data request

E1062: No files in multipart/form-data request

E1063: Already linked to this OAuth provider

E1064: Invalid OAuth state parameter

E1065: Invalid MIME type

E2000: Invalid login session

E2001: Invalid token

E2002: Not logged in

E2003: OAuth provider is not configured (or misconfigured)

E2004: Invalid login steps (cookie relying on token)

E3000: Admin only

E3001: Metrics are disabled

E3002: Folder is not open

E3003: Parent folder does not belong to you

E3004: Password protected

`application/json`

`application/json`