List files

$ lightfield file list

GET/v1/files

Returns a paginated list of files in your workspace. Use offset and limit to paginate through results. See List endpoints for more information about pagination.

Required scope: files:read

Rate limit category: Search

ParametersExpand Collapse

--limit: optional number

Maximum number of records to return. Defaults to 25, maximum 25.

--offset: optional number

Number of records to skip for pagination. Defaults to 0.

ReturnsExpand Collapse

file_list_response: object { data, object, totalCount }

data: array of object { id, completedAt, createdAt, 5 more }

Array of file objects for the current page.

id: string

Unique identifier for the file.

completedAt: string

When the file upload was completed.

createdAt: string

When the file upload session was created.

expiresAt: string

When the upload session expires. Null once completed, cancelled, or expired.

filename: string

Original filename.

mimeType: string

MIME type of the file.

sizeBytes: number

File size in bytes.

status: "PENDING" or "COMPLETED" or "CANCELLED" or "EXPIRED"

Current upload status of the file.

"PENDING"

"COMPLETED"

"CANCELLED"

"EXPIRED"

object: string

The object type, always "list".

totalCount: number

Total number of matching files.

List files

lightfield file list \
  --api-key 'My API Key'

{
  "data": [
    {
      "id": "id",
      "completedAt": "completedAt",
      "createdAt": "createdAt",
      "expiresAt": "expiresAt",
      "filename": "filename",
      "mimeType": "mimeType",
      "sizeBytes": -9007199254740991,
      "status": "PENDING"
    }
  ],
  "object": "object",
  "totalCount": 0
}

Returns Examples

{
  "data": [
    {
      "id": "id",
      "completedAt": "completedAt",
      "createdAt": "createdAt",
      "expiresAt": "expiresAt",
      "filename": "filename",
      "mimeType": "mimeType",
      "sizeBytes": -9007199254740991,
      "status": "PENDING"
    }
  ],
  "object": "object",
  "totalCount": 0
}