Skip to content
Get started

List files

$ deeptable files list
GET/v1/files

List all files uploaded by the current user.

ParametersExpand Collapse
--after: optional string

A cursor for pagination. Use the last_id from a previous response to fetch the next page.

--limit: optional number

Maximum number of files to return.

ReturnsExpand Collapse
FileListResponse: object { data, has_more, object, 2 more }

Paginated response for listing files.

Uses cursor-based pagination for efficient iteration through results.

data: array of File { id, content_type, created_at, 3 more }

List of files.

id: string

The unique identifier for this file.

content_type: string

The MIME type of the file.

created_at: string

The timestamp when the file was uploaded.

file_name: string

The original filename of the uploaded file.

object: "file"

The object type, which is always 'file'.

"file"
size: number

The size of the file in bytes.

has_more: boolean

Whether there are more results available after this page.

object: "list"

The object type, which is always 'list'.

"list"
first_id: optional string

Unique identifier for a file.

last_id: optional string

Unique identifier for a file.

List files

deeptable files list \
  --api-key 'My API Key'
{
  "data": [
    {
      "id": "file_01kfxgjd94fn9stqm414vjb0s8",
      "content_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
      "created_at": "2024-01-15T10:30:00Z",
      "file_name": "financial_report.xlsx",
      "object": "file",
      "size": 1048576
    }
  ],
  "has_more": false,
  "object": "list",
  "first_id": "file_01kfxgjd94fn9stqm414vjb0s8",
  "last_id": "file_01kfxgjd94fn9stqm414vjb0s8"
}
Returns Examples
{
  "data": [
    {
      "id": "file_01kfxgjd94fn9stqm414vjb0s8",
      "content_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
      "created_at": "2024-01-15T10:30:00Z",
      "file_name": "financial_report.xlsx",
      "object": "file",
      "size": 1048576
    }
  ],
  "has_more": false,
  "object": "list",
  "first_id": "file_01kfxgjd94fn9stqm414vjb0s8",
  "last_id": "file_01kfxgjd94fn9stqm414vjb0s8"
}