Retrieve a file

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: str

Unique identifier of the file to retrieve.

ReturnsExpand Collapse

class FileRetrieveResponse: …

id: str

Unique identifier for the file.

completed_at: Optional[str]

When the file upload was completed.

created_at: str

When the file upload session was created.

expires_at: Optional[str]

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

filename: str

Original filename.

mime_type: str

MIME type of the file.

size_bytes: int

File size in bytes.

minimum-9007199254740991

maximum9007199254740991

status: Literal["PENDING", "COMPLETED", "CANCELLED", "EXPIRED"]

Current upload status of the file.

One of the following:

"PENDING"

"COMPLETED"

"CANCELLED"

"EXPIRED"

Retrieve a file

from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
file_retrieve_response = client.file.retrieve(
    "id",
)
print(file_retrieve_response.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"
}