Retrieve a file

client.File.Get(ctx, id) (*FileRetrieveResponse, error)

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

type FileRetrieveResponse struct{…}

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 int64

File size in bytes.

minimum-9007199254740991

maximum9007199254740991

Status FileRetrieveResponseStatus

Current upload status of the file.

One of the following:

const FileRetrieveResponseStatusPending FileRetrieveResponseStatus = "PENDING"

const FileRetrieveResponseStatusCompleted FileRetrieveResponseStatus = "COMPLETED"

const FileRetrieveResponseStatusCancelled FileRetrieveResponseStatus = "CANCELLED"

const FileRetrieveResponseStatusExpired FileRetrieveResponseStatus = "EXPIRED"

Retrieve a file

package main

import (
  "context"
  "fmt"

  "github.com/Lightfld/lightfield-go"
  "github.com/Lightfld/lightfield-go/option"
)

func main() {
  client := githubcomlightfldlightfieldgo.NewClient(
    option.WithAPIKey("My API Key"),
  )
  fileRetrieveResponse, err := client.File.Get(context.TODO(), "id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", 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"
}