Skip to main content
GET
JavaScript
path is a directory path rooted at the device’s shared storage — / is the storage root (primary external storage on Android devices), e.g. /Download. The response contains the directory’s direct entries only — it does not recurse into subdirectories. File access is available on Android devices only; file requests against an iOS device fail with 400.
Depending on the device type, some entry metadata (owner, group, permissions, hardLinks) may be zeroed rather than reflect real values.

Invalid directories

On hosted Android Phones, nonexistent directories return 404 DEVICE_PATH_NOT_FOUND, files used as directories return 422 DEVICE_PATH_NOT_DIRECTORY, and unreadable directories return 403 DEVICE_PATH_FORBIDDEN. A readable empty directory remains a successful listing with zero entries. Paths retain the external-storage scope: / means primary shared storage, and /data/... does not grant app-private filesystem access.

Authorizations

Authorization
string
header
required

Bearer token via Authorization header

Headers

X-Device-Display-ID
integer<int64>
default:0
Required range: x >= 0

Path Parameters

deviceId
string
required

Query Parameters

path
string
required

Response

OK

files
object[] | null
required
path
string
required
total
integer<int64>
required
$schema
string<uri>
read-only

A URL to the JSON Schema for this object.

Example:

"https://example.com/schemas/FileListBody.json"