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.

get

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.

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

get
/transfer/inbox

Last updated

Was this helpful?