Getting received files
Learn about listing all files received by one or more accounts within an organization using the Filemail API.
Use the GET /transfer/inbox endpoint to list all transfers received by a user, or received by any user in an organization (Admin role is required in this case). The response will provide details about each transfer, including transfer IDs needed to fetch the transfer details using Getting transfer details.
Returns a list of transfers received by currently authenticated user, or received by all users in the authenticated user's organization. Optionally allows to filter transfers received only after specified date.
The start date for filtering received transfer. Only transfers received after this date will be returned. Expected format: unix time in milliseconds.
When set to true the response will include also transfers received by other users in the organization. In case current user is not an organization administrator - this flag will be ignored.
GET /transfer/inbox HTTP/1.1
Host: api-public.filemail.com
Accept: */*
{
"responsestatus": "OK",
"errorid": "text",
"errormessage": "text",
"data": {
"transfers": [
{
"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",
"listitems": "text",
"required": true,
"visible": true,
"type": "text",
"rendertype": 1,
"sortorder": 1,
"length": 1,
"startValue": 1,
"placeholder": "text",
"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,
"occupiesstorage": true,
"infected_deleted": [
"text"
]
}
]
},
"errorcode": 1
}Last updated
Was this helpful?