Files

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

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.

get/api/workspaces/{slug}/files

Request

  • Base URL
    https://trydock.ai
  • Auth
    HTTP bearer

Path parameters

slugstring required

Query parameters

surfaceSlugstring required
parentFolderIdstring

Folder id to descend into; omit or pass 'null' for root.

view'starred' | 'recent'

Override the default folder-scoped listing.

qstring
Example:hero
sort'name' | 'createdAt' | 'updatedAt' | 'size' | 'mimeType'
order'asc' | 'desc'

Response

Folders + files

Example response

{
  "files": [
    {
      "id": "cmpfile_…",
      "name": "hero.png",
      "mimeType": "image/png"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.