v48

latestOpenAPI 3.0.0raw.githubusercontent.com2025-12-0297180624.8 KB
File System

Get file/dir

Retrieves metadata for a specific file or directory inside a box

get/boxes/{boxId}/fs/info

Path parameters

boxIdstring required
Example:c9bdc193-b54b-4ddb-a035-5ac0c598d32d

Box ID

Query parameters

workingDirstring
Example:/home/user/documents

Working directory. If not provided, the file will be read from the box.config.workingDir directory.

pathstring required
Example:/home/user/documents/output.txt

Target path in the box. If the path does not start with '/', the file/directory will be checked relative to the working directory

Response

Get file/dir

OR

Example response

{
  "name": "example.txt",
  "path": "/path/to/example.txt",
  "size": "10MB",
  "mode": "755",
  "lastModified": "2021-01-01T00:00:00Z"
}