Référence APIRécupérer un transfert
GET/v1/transfers/{id}

Récupérer un transfert

Renvoie les métadonnées complètes d'un transfert, fichiers inclus.

2 min de lectureTélécharger en PDF

Requête exemple

"null"

Réponse exemple

"{\"id\":\"a3f1c9e2-7b4d-4e8a-9c12-5f6a8b2d1e34\",\"object\":\"transfer\",\"created_at\":\"2026-06-01T09:14:22.000Z\",\"expires_at\":\"2026-06-08T09:14:22.000Z\",\"scheduled_at\":null,\"workspace_id\":\"d2b7e4a1-0c3f-4a6b-8e91-1f2a3b4c5d6e\",\"user_id\":\"6e9c1a2b-3d4f-4a5b-8c7d-9e0f1a2b3c4d\",\"short_code\":\"K7M2QX\",\"support_id\":\"SUP-10482\",\"status\":\"active\",\"transfer_title\":\"Livrables campagne Q2\",\"notes\":\"Version finale validee\",\"folder_id\":null,\"is_password_protected\":true,\"require_totp\":false,\"max_downloads\":50,\"total_downloads\":7,\"auto_delete\":true,\"burn_after_read\":false,\"encryption_mode\":\"server_side\",\"encryption_metadata\":null,\"scan_status\":\"clean\",\"scan_result\":{\"engine\":\"clamav\",\"threats\":0},\"scanned_at\":\"2026-06-01T09:15:01.000Z\",\"ip_allowlist\":null,\"ip_blocklist\":null,\"geo_allowlist\":[\"FR\",\"BE\"],\"geo_blocklist\":null,\"watermark_enabled\":false,\"watermark_text\":null,\"expiry_notification_sent\":false,\"download_report_sent\":false,\"files\":[{\"id\":\"b8c2d3e4-5f6a-4b7c-8d9e-0a1b2c3d4e5f\",\"file_name\":\"rapport-final.pdf\",\"file_size\":2418562,\"file_type\":\"application/pdf\",\"created_at\":\"2026-06-01T09:14:40.000Z\"},{\"id\":\"c9d3e4f5-6a7b-4c8d-9e0f-1a2b3c4d5e6f\",\"file_name\":\"visuels.zip\",\"file_size\":18742039,\"file_type\":\"application/zip\",\"created_at\":\"2026-06-01T09:14:55.000Z\"}]}"

Récupère les détails complets d'un transfert unique appartenant à votre espace de travail, identifié par son id (UUID). En plus de toutes les colonnes du transfert (statut, expiration, protections, mode de chiffrement, compteurs de téléchargement), la réponse inclut un tableau files listant les fichiers rattachés. Comportement notable : la requête est strictement filtrée sur le workspace_id du token, donc un identifiant existant mais appartenant à un autre espace renvoie 404 not_found plutôt que 403, ce qui évite toute fuite d'information entre espaces. L'endpoint ne déchiffre rien et n'expose jamais de secret (password_hash et totp_secret restent des valeurs internes, ne les utilisez pas côté client).

Authentification

Requiert une clé API valide passée via Authorization: Bearer cof_live_... (ou cof_test_..., cof_rk_..., cof_mcp_...). Le scope requis est transfers:read. Une clé restreinte sans ce scope est rejetée avec scope_missing (403). S'agissant d'une lecture (GET), l'endpoint n'applique pas d'idempotence et compte sur le quota de débit de classe read de votre espace.

Paramètres de requête

Aucun paramètre de requête (query string). Le seul paramètre est le segment de chemin id.

ParamètreEmplacementTypeRequisDescription
idchemin (path)string (UUID)OuiIdentifiant du transfert à récupérer. Doit appartenir à l'espace de travail du token, sinon 404.

Réponse

Renvoie l'objet transfert avec l'ensemble de ses colonnes, augmenté d'un tableau files. Champs clés : id et short_code (code court public), status (active, scheduled, expired ou deleted), expires_at et scheduled_at (dates ISO 8601), is_password_protected et require_totp (protections d'accès), max_downloads et total_downloads (quota et usage), auto_delete et burn_after_read (cycle de vie), encryption_mode (server_side ou e2e_v1) avec encryption_metadata, scan_status/scan_result (analyse antivirus), les listes ip_allowlist/ip_blocklist/geo_allowlist/geo_blocklist, ainsi que transfer_title, notes, folder_id et workspace_id. Le tableau files contient, pour chaque fichier : id, file_name, file_size (octets), file_type (MIME) et created_at. Il vaut [] si le transfert n'a aucun fichier.

Erreurs

Code HTTPCodeQuandComment résoudre
401missing_api_keyEn-tête Authorization absentAjoutez Authorization: Bearer cof_live_....
401invalid_api_keyPréfixe de clé invalide ou clé inconnue/révoquéeVérifiez la valeur et l'environnement de la clé (live vs test).
403scope_missingLa clé (restreinte) ne porte pas transfers:readRégénérez une clé incluant le scope transfers:read.
404not_foundAucun transfert avec cet id dans l'espace de travailVérifiez l'id et que le transfert appartient bien à l'espace de la clé.
429rate_limitedQuota de requêtes/minute (classe read) dépasséRespectez l'en-tête Retry-After et lissez les appels.
500internal_errorErreur interne lors de la lecture en baseRéessayez ; si cela persiste, contactez le support avec le request_id.

Voir aussi

GET/v1/transfersListe paginée des transferts de l'espace de travail.GET/v1/transfers/{id}/filesDétail des fichiers d'un transfert.DELETE/v1/transfers/{id}Supprime le transfert (scope transfers:write).