---
title: "List files (with optional sort, search, starred, recent views)"
method: GET
path: "/api/workspaces/{slug}/files"
tags: ["Files"]
---

# List files (with optional sort, search, starred, recent views)

`GET /api/workspaces/{slug}/files`

## Request

- Base URL: `https://trydock.ai`
- URL: `https://trydock.ai/api/workspaces/{slug}/files`
- Auth: HTTP bearer

Returns folders + files in the given Files surface. Default view = current folder's children. Pass `view=starred` for a flat surface-wide starred list, `view=recent` for the 50 most-recently-updated. `q` widens to a surface-wide name-contains search. `sort` + `order` override the default name asc.

## Path parameters

- `slug` string, required

## Query parameters

- `surfaceSlug` string, required
- `parentFolderId` string: Folder id to descend into; omit or pass 'null' for root.
- `view` 'starred' | 'recent': Override the default folder-scoped listing.
- `q` string
- `sort` 'name' | 'createdAt' | 'updatedAt' | 'size' | 'mimeType'
- `order` 'asc' | 'desc'

## Response `200`

Folders + files

- object
  - `folders` object[], required
    - `id` string, required
    - `name` string, required
    - `parentFolderId` string, nullable, required
    - `position` integer, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `files` object[], required
    - `id` string, required
    - `name` string, required
    - `parentFolderId` string, nullable, required
    - `size` integer, required: Bytes.
    - `mimeType` string, required
    - `thumbUrl` string, nullable, required: Server-generated 256-px webp URL. Null for non-raster files.
    - `starred` boolean
    - `starredAt` string, date-time, nullable
    - `description` string, nullable
    - `tags` string[]
    - `exif` object, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required

## Other responses

- `404`: Files surface not found

## Changes

- **2026-11-05** `767beae124a8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/trydock/apis/dock-rest-api/changes/api/workspaces/:slug/files/get.md)

---

[API](https://skmtc.dev/trydock/apis/dock-rest-api.md) - [All operations](https://skmtc.dev/trydock/apis/dock-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/trydock/apis/dock-rest-api/revisions/dd96ae96a412?raw)
