Getting transfer details

This article explains how to get transfer details, including all files in a transfer through the Filemail API.

When you know the ID of a transfer, you can get all details about this transfer as well as recipients and files belonging to it. Please note that the amount of received data will depend on the authenticated user's relation to the transfer.

For non-administrator users of the Filemail account: If the transfer was sent by a different user than yourself, you will not have access to transfer key, recipients and download tracking.

For administrator users of the Filemail account: If the transfer was not sent or received by a user in your organization, you will not have access to transfer key, recipients and download tracking.

Recipients

The Recipients object will return a list of recipients of the transfer. For each recipient, you can see their e-mail address, the unique trackable download link, if e-mail delivery was successful and any error that might have been returned from mail server in case e-mail delivery failed.

Custom fields

Depending on how your inboxes have been set up, you might have received transfers with some custom data attached to them. The list of all configured custom fields are available in the transfer details and you will be able to get their values along many other properties.

Files

The list of files contained in the transfer is attached. Every file includes downloadurl that can be used to download that specific file. The is also other metadata available for each file.

Downloads

Each file will have a list of downloads attached to it. This is information about who downloaded the files together with other useful information about the download.

Retrieve an existing transfer by ID.

get

This endpoint retrieves transfer details, file list, recipients, download tracking information and other transfer meta data.

Path parameters

transferidstringRequired

The transfer ID - unique transfer identifier. It is returned after initializing a transfer, also it is available in transfer list responses (sent and received). This parameter is optional, since transfers can also be fetched by providing trackid. When transferid is not used, then trackid must be specified.

Query parameters

trackidstringOptional

The unique tracking identifier of a transfer. Use this parameter as an alternative to transfer ID. Tracking identifiers are included in emails sent out to transfer recipients, and they are unique for each recipient.

filesLimitinteger · int32Optional

Limit the number of files included in the response. Specify -1 to get all files.

withDetailsbooleanOptional

Controls whether all transfer details should be returned. When set to false the response will not include files, download tracking and other more advanced details. When not specified - it defaults to true.

excludeFilesbooleanOptional

When set to true the response will not include transfer files. Defaults to false. Note: this flag is effective only when withDetails is true.

excludeDownloadsbooleanOptional

When set to true the response will not include downlaod tracking information. Defaults to false. Note: this flag is effective only when withDetails is true.

passwordstringOptional

Password is required when a transfer has been password-proteced by the sender.

captchastringOptional

Might be require in case wrong transfer password has been specified too many times.

fpropsstringOptional

A comma-separated list of property names to include in every file on the file list. This can help reduce the total response size when fetching transfers with a large number of files. E.g. 'filename,downloadurl'

Responses

200

OK - Returned when transfer is found and successfully retrieved.

text/plainapplication/jsontext/json

401

Unauthorized - for password protected transfers - returned when wrong password or no password has been provided.

text/plainapplication/jsontext/json

404

Not found - returned in case of an invalid transfer ID.

text/plainapplication/jsontext/json

409

Conflict

text/plainapplication/jsontext/json

get

/transfer/{transferid}

HTTPcURLJavaScriptPython

GET /transfer/{transferid} HTTP/1.1
Host: api-public.filemail.com
Accept: */*

{
  "responsestatus": "OK",
  "errorid": "text",
  "errormessage": "text",
  "data": {
    "recipients": [
      {
        "email": "text",
        "downloadlink": "text",
        "delivered": true,
        "deliveryerror": "text"
      }
    ],
    "failedRecipients": 1,
    "from": "text",
    "subject": "text",
    "message": "text",
    "expiredate": 1,
    "extendedexpiredate": 1,
    "sentdate": 1,
    "notify": true,
    "status": "text",
    "id": "text",
    "trackid": "text",
    "url": "text",
    "size": 1,
    "customlogourl": "text",
    "compressedfileurl": "text",
    "compressedfilestatus": "text",
    "compressedfileformat": "text",
    "torrentstatus": "text",
    "torrenturl": "text",
    "days": 1,
    "isexpired": true,
    "source": "text",
    "key": "text",
    "fileserver": "text",
    "fileserverurl": "text",
    "fileserverurl_main": "text",
    "footertext": "text",
    "containsmorefiles": 1,
    "customfields": [
      {
        "customfieldid": "text",
        "defaultvalue": "text",
        "description": "text",
        "label": "text",
        "customLabel": "text",
        "listitems": "text",
        "required": true,
        "visible": true,
        "type": "text",
        "rendertype": 1,
        "sortorder": 1,
        "length": 1,
        "startValue": 1,
        "placeholder": "text",
        "removable": true,
        "editableType": true,
        "editableRequired": true,
        "value": "text",
        "barcodeimage": "text"
      }
    ],
    "files": [
      {
        "filename": "text",
        "filesize": 1,
        "downloadurl": "text",
        "fileid": "text",
        "thumbid": "text",
        "previewurl": "text",
        "hascustompreview": true,
        "videopreview": {
          "ANY_ADDITIONAL_PROPERTY": {
            "size": 1,
            "resolution": 1,
            "downloadUrl": "text"
          }
        },
        "downloads": [
          {
            "downloaddate": 1,
            "ip": "text",
            "email": "text",
            "location": "text",
            "locationurl": "text",
            "locationflag": "text",
            "kBps": 1,
            "filename": "text",
            "filesize": 1,
            "downloadtype": "SingleFile"
          }
        ],
        "filetype": "text",
        "filetypedescription": "text",
        "category": "text",
        "smallpreview": "text",
        "mediumpreview": "text",
        "largepreview": "text",
        "hascustomthumbnail": true,
        "transferid": "text",
        "md5": "text",
        "suspecteddamage": true
      }
    ],
    "numberoffiles": 1,
    "numberofdownloads": 1,
    "downloads": [
      {
        "downloaddate": 1,
        "ip": "text",
        "email": "text",
        "location": "text",
        "locationurl": "text",
        "locationflag": "text",
        "kBps": 1,
        "filename": "text",
        "filesize": 1,
        "downloadtype": "SingleFile"
      }
    ],
    "antivirusscanstatus": "text",
    "passwordprotected": true,
    "iconcolor": "text",
    "iconletter": "text",
    "ftphost": "text",
    "region": "text",
    "protocol": "text",
    "e2ee": true,
    "kind": "text",
    "ftpcorppasswordrequired": true,
    "udpthreshold": 1,
    "permanent": true,
    "maxdays": 1,
    "allowediting": true,
    "alloweditingexpiredate": true,
    "blockdownloads": true,
    "infected": true,
    "infected_deleted": [
      "text"
    ]
  },
  "errorcode": 1
}