Getting received files
Learn about listing all files received by one or more accounts within an organization using the Filemail API.
get
Query parameters
frominteger · int64Optional
The start date for filtering received transfer. Only transfers received after this date will be returned. Expected format: unix time in milliseconds.
getForAllUsersbooleanOptional
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.
portalIdstring[]Optional
Specify a list of portal IDs to get only transfers sent to those portals.
getexpiredbooleanOptional
When set to true the response will include also expired transfers.
limitinteger · int32Optional
Optional amount of inbox items to fetch (paging). Defaults to custom max page size specified for a company account, or system default (1000).
skipinteger · int32Optional
Optional amount of inbox items to skip (paging). Defaults to 0.
searchstringOptional
Optional search phrase, which will filter transfers by ID, subject, message, sender, recipients and custom fields.
ignoreDeletedPortalsbooleanOptional
Optional boolean flag. Set to true if you want the API to ignore case, when some of provided portal IDs are deleted. When this flag is not set, it defaults to false, and then this endpoint will throw a 409 error if any of provided portals has been deleted.
Responses
200
OK
responsestatusstring · enumOptionalPossible values:
erroridstring · nullableOptional
errormessagestring · nullableOptional
errorcodeinteger · int32 · nullableRead-onlyOptional
Numeric representation of the responsestatus field.
401
Unauthorized
get/transfer/inbox
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",
"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"
]
}
],
"portal": {
"portalId": "text",
"friendlyName": "text",
"uploadCount": 1,
"isDefault": true
},
"inboxOwner": {
"maxdownloads": 1,
"maxdays": 1,
"maxtransfersize": 1,
"membershipname": "text",
"istrial": true,
"defaultnotify": true,
"defaultdays": 1,
"defaultconfirmation": true,
"defaultdownloads": 1,
"id": "text",
"name": "text",
"intercomhash": "text",
"email": "text",
"mobilephone": "text",
"signature": "text",
"defaultsubject": "text",
"country": "text",
"newsletter": true,
"allowCommunicationEmails": true,
"startpage": "text",
"created": 1,
"ssoPlatform": "text",
"cansend": true,
"expired": true,
"emailverifiedforsending": true,
"freelimitreached": true,
"companyname": "text",
"companyid": "text",
"admin": true,
"role": 1,
"forcepasswordonincoming": true,
"canreceivefiles": true,
"buttonscolor": "text",
"buttonstextcolor": "text",
"companylogo": "text",
"showallrecipients": true,
"canstorefilesforever": true,
"enforcepasswordpolicy": true,
"udpenabled": true,
"allowunlimiteddays": true,
"allow3months": true,
"canAccessOthersFiles": true,
"subscription": {
"active": true,
"expireDate": 1,
"currency": "text",
"interval": "text",
"membershipname": "text",
"showExVatLabelOnPrices": true,
"allowMultipleUsers": true,
"licenseCount": 1,
"licensePrice": 1,
"pricePerTBPerUser": 1,
"subscriptionPrice_Users": 1,
"subscriptionPrice_Storage": 1,
"subscriptionPrice_Total": 1,
"paymentGateway": "PayPal",
"licensesInUse": 1,
"canChangePlan": {
"state": "active",
"reason": "text",
"link": "text"
},
"canUpdatePaymentMethod": {
"state": "active",
"reason": "text",
"link": "text"
},
"changeSubscriptionMobileAppLink": "text",
"canChangeInterval": {
"state": "active",
"reason": "text",
"link": "text"
},
"canManageLicenses": {
"state": "active",
"reason": "text",
"link": "text"
},
"canChangeLicenseCount": {
"state": "active",
"reason": "text",
"link": "text"
},
"canCancel": {
"state": "active",
"reason": "text",
"link": "text"
},
"canUpgrade": {
"state": "active",
"reason": "text",
"link": "text"
},
"isTrial": true,
"nextPaymentDate": 1,
"paymentMethod": {
"paymentMethod": "PayPal",
"creditCardBrand": "text",
"creditCardLast4": "text",
"creditCardName": "text",
"creditCardExpireYear": 1,
"creditCardExpireMonth": 1,
"payPalEmail": "text",
"paymentMethodTextInfo": "text"
},
"storageBytesInUse": 1,
"storageBytesLimit": 1,
"storageBytesIncludedInMembership": 1,
"storageBytesAdditional": 1
},
"storageinuse": 1,
"storagelimit": 1,
"passwordMinLength": 1,
"contactgroups": [
{
"numberofcontacts": 1,
"contactgroupid": "text",
"contactgroupname": "text",
"corp_shared": true,
"allow_edit": true,
"contacts": [
"[Circular Reference]"
]
}
],
"twoFactorEnabled": true,
"loglevel": "text",
"maxrecipients": 1,
"maxrecipientsaftertrial": 1,
"allowautodownloads": true,
"allowpasswordprotection": true,
"allowdownloadtracking": true,
"allowe2ee": true,
"allowPortals": true,
"allowMultiplePortals": true,
"canManageSubscription": true,
"requireE2EEwhenSending": true,
"requireE2EEwhenReceiving": true
}
},
"errorcode": 1
}Last updated
Was this helpful?