Transfers

Retrieve all

GET https://transferferry.com/api/transfers/
curl --request GET \
--url 'https://transferferry.com/api/transfers/' \
--header 'Authorization: Bearer {api_key}' \
Parameters Details Description
page Optional Integer The page number that you want results from. Defaults to 1.
results_per_page Optional Integer How many results you want per page. Allowed values are: 10 , 25 , 50 , 100 , 250 , 500 , 1000. Defaults to 25. 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "project_id": 0,
            "uploader_id": "f528764d624db129b32c21fbca0cb8d6",
            "pixels_ids": [],
            "files_ids": [
                1,2,3
            ],
            "name": "Example",
            "description": "Example",
            "type": "link",
            "email_to": null,
            "url": "example",
            "settings": {
                "password": null,
                "file_encryption_is_enabled": false,
                "file_preview_is_enabled": true,
                "is_removed_branding": false,
                "custom_css": "tester",
                "custom_js": ""
            },
            "notifications": {
                "download": []
            },
            "total_files": 1,
            "total_size": 999999,
            "pageviews": 1,
            "downloads": 1,
            "downloads_limit": 0,
            "expiration_datetime": null,
            "last_datetime": null,
            "datetime": "2025-09-15 10:48:12",
        },
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://transferferry.com/api/transfers?page=1",
        "last": "https://transferferry.com/api/transfers?page=1",
        "next": null,
        "prev": null,
        "self": "https://transferferry.com/api/transfers?page=1"
    }
}

Retrieve one

GET https://transferferry.com/api/transfers/{transfer_id}
curl --request GET \
--url 'https://transferferry.com/api/transfers/{transfer_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "project_id": 0,
        "uploader_id": "f528764d624db129b32c21fbca0cb8d6",
        "pixels_ids": [],
        "files_ids": [
            1,2,3
        ],
        "name": "Example",
        "description": "Example",
        "type": "link",
        "email_to": null,
        "url": "example",
        "settings": {
            "password": null,
            "file_encryption_is_enabled": false,
            "file_preview_is_enabled": true,
            "is_removed_branding": false,
            "custom_css": "tester",
            "custom_js": ""
        },
        "notifications": {
            "download": []
        },
        "total_files": 1,
        "total_size": 999999,
        "pageviews": 1,
        "downloads": 1,
        "downloads_limit": 0,
        "expiration_datetime": null,
        "last_datetime": null,
        "datetime": "2025-09-15 10:48:12",
    }
}

Create

POST https://transferferry.com/transfer/create_api
Parameters Details Description
uploaded_files Required Array Integer Array containing UUID's for all the uploaded files to be attached to this transfer.
type Optional String Allowed values: link , email
email_to Optional String Available when: type = email
name Optional String -
description Optional String -
url Optional String -
domain_id Optional Integer -
project_id Optional Integer -
pixels_ids Optional Array Integer -
download_notification_handlers_ids Optional Array Integer -
expiration_datetime Optional String Y-m-d H:i:s
downloads_limit Optional Integer -
password Optional String -
file_encryption_is_enabled Optional Boolean -
file_preview_is_enabled Optional Boolean -
gallery_file_preview_is_enabled Optional Boolean -
is_removed_branding Optional Boolean -
custom_css Optional String -
custom_js Optional String -
curl --request POST \
--url 'https://transferferry.com/transfer/create_api' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'uploaded_files[]=de09be56-639f-4213-863b-5ea1aa065970' \
--form 'name=Example name' \
--form 'description=Example description' \
{
    "data": {
        "id": 1,
        "download_url": "https://transferferry.com/transfer-redirect/1",
        "view_url": "https://transferferry.com/transfer/1",
    }
}

Update

POST https://transferferry.com/api/transfers/{transfer_id}
Parameters Details Description
name Optional String -
description Optional String -
url Optional String -
domain_id Optional Integer -
project_id Optional Integer -
pixels_ids Optional Array Integer -
download_notification_handlers_ids Optional Array Integer -
expiration_datetime Optional String Y-m-d H:i:s
downloads_limit Optional Integer -
file_preview_is_enabled Optional Boolean -
gallery_file_preview_is_enabled Optional Boolean -
is_removed_branding Optional Boolean -
custom_css Optional String -
custom_js Optional String -
curl --request POST \
--url 'https://transferferry.com/api/transfers/{transfer_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'host=transfer.com' \
{
    "data": {
        "id": 1
    }
}

Delete

DELETE https://transferferry.com/api/transfers/{transfer_id}
curl --request DELETE \
--url 'https://transferferry.com/api/transfers/{transfer_id}' \
--header 'Authorization: Bearer {api_key}' \