---
title: "List a volume's files"
method: GET
path: "/volumes/{volume_id}/files"
tags: ["General APIs with JWT"]
---

# List a volume's files

`GET /volumes/{volume_id}/files`

## Request

- Base URL: `https://lium.io/api`
- URL: `https://lium.io/api/volumes/{volume_id}/files`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`
- TypeScript: <https://skmtc.dev/lium/apis/lium-backend-api/docs/volumes/:volume_id/files/get.ts> (a function with typed inputs; its response is checked against the schema)

List the files and folders directly under `prefix` in a volume, without mounting it on a pod. Names are relative to the volume root (`/mnt` in a pod). Pass `next_cursor` back as `cursor` for the next page. Listing reads no file contents, so it bills no egress.

## Path parameters

- `volume_id` string, uuid, required

## Query parameters

- `prefix` string: Folder to list, e.g. data/
- `cursor` string, nullable: next_cursor from the previous page
- `limit` integer

## Response `200`

Files and folders under the prefix

- VolumeFileListResponse
  - `files` VolumeFile[], required
    - `name` string, required: Path relative to the volume root (/mnt in a pod)
    - `size` integer, required: Size in bytes
    - `last_modified` string, required: ISO 8601 timestamp
  - `folders` string[], required: Folder prefixes one level below `prefix`, each ending in '/'
  - `next_cursor` string, nullable: Pass as `cursor` for the next page; null at the end

## Other responses

- `400`: Invalid prefix or cursor
- `403`: Forbidden for this caller (API key scope or workspace membership)
- `404`: Volume not found
- `422`: Validation Error
- `429`: Too many listing requests
- `500`: Internal server error

## Changes

- **2026-11-03** `984fed2934a4`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/lium/apis/lium-backend-api/changes/volumes/:volume_id/files/get.md)

---

[API](https://skmtc.dev/lium/apis/lium-backend-api.md) - [All operations](https://skmtc.dev/lium/apis/lium-backend-api/llms.txt) - [OpenAPI document](https://skmtc.dev/lium/apis/lium-backend-api/revisions/f5f94aa0bc8e?raw)