Retrieve a file

client.file.retrieve(, ?): FileRetrieveResponse { id, completedAt, createdAt, 5 more }

GET/v1/files/{id}

Retrieves a single file by its ID.

This works for any file id you already hold, including ones returned in a CRM record’s $files relationship — not only files created through POST /v1/files. See File uploads for which document classes are retrievable by id versus enumerable through GET /v1/files.

Required scope: files:read

Rate limit category: Read

ParametersExpand Collapse

id: string

Unique identifier of the file to retrieve.

ReturnsExpand Collapse

FileRetrieveResponse { id, completedAt, createdAt, 5 more }

id: string

Unique identifier for the file.

completedAt: string | null

When the file upload was completed.

createdAt: string

When the file upload session was created.

expiresAt: string | null

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.

minimum-9007199254740991

maximum9007199254740991

status: "PENDING" | "COMPLETED" | "CANCELLED" | "EXPIRED"

Current upload status of the file.

One of the following:

"PENDING"

"COMPLETED"

"CANCELLED"

"EXPIRED"

Retrieve a file

import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const fileRetrieveResponse = await client.file.retrieve('id');

console.log(fileRetrieveResponse.id);

{
  "id": "id",
  "completedAt": "completedAt",
  "createdAt": "createdAt",
  "expiresAt": "expiresAt",
  "filename": "filename",
  "mimeType": "mimeType",
  "sizeBytes": -9007199254740991,
  "status": "PENDING"
}

Returns Examples

{
  "id": "id",
  "completedAt": "completedAt",
  "createdAt": "createdAt",
  "expiresAt": "expiresAt",
  "filename": "filename",
  "mimeType": "mimeType",
  "sizeBytes": -9007199254740991,
  "status": "PENDING"
}