Directory

Operations for managing files and folders

List Directory

List files and folders within a specified directory

POST

https://dev.officex.app/v1/drive/{organization_id}/directory/list

Run In Postman

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema

folder_id	string or null ID of the folder to list contents from	FolderID_c9107c9a-4f1f-444f-b921-1ebce17cfbf1
path	string or null Path to the folder to list contents from
filters	string <= 256 characters Default: "" Filter string for disks
page_size	integer [ 1 .. 1000 ] Default: 50 Number of items per page	50
direction	string Default: "ASC" Enum: "ASC" "DESC" Sort direction	ASC
cursor	string or null <= 256 characters Cursor for pagination

Responses

success

{
    "folders": [],
    "files": [],
    "total_files": 0,
    "total_folders": 0,
    "cursor": null,
    "breadcrumbs": [],
    "permission_previews": [
        "VIEW",
        "EDIT",
        "UPLOAD",
        "DELETE",
        "INVITE",
        "MANAGE"
    ]
}

error

{
  "err": {
    "code": 0,
    "message": "string"
  }
}

Typescript Types

	type
Request	IRequestListDirectory
Response	IResponseListDirectory

---

Directory Actions

Perform actions on files and folders such as get, create, update, delete, copy, move, and restore

POST

https://dev.officex.app/v1/drive/{organization_id}/directory/action

Header Parameters

Authorization (required)	stringBearer TOKEN Bearer token for authentication	Bearer eyJhbGciOiJIUz...

Path Parameter

organization_id (required)	string (DriveID) Unique identifier for a drive	DriveID_abc123

Request Body schema

actions (required)	Array of objects (DirectoryAction) List of directory actions to execute

{
  "actions": [
    {
      // Required: The operation to perform (e.g., DELETE_FOLDER, MOVE_FILE, CREATE_FOLDER)
      "action": "DELETE_FOLDER",
      
      // Optional: Target resource - use either path OR id
      "target": {
        "resource_path": "/path/to/resource",  // Full path to file/folder
        "resource_id": "FolderID_abc123"       // Unique ID (FileID_<id> or FolderID_<id>)
      },
      
      // Required: Action-specific data
      "payload": {
        // Payload content varies by action type
        // Common fields: destination_path, overwrite, permissions, metadata
      }
    }
  ]
}

Typescript Types

	type
Request	IRequestDirectoryAction
Response	IResponseDirectoryAction

Refer Directory Actions for detailed request body schema