Exporter les transferts

Réponse exemple

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-4789-a0b1-c2d3e4f5a6b7",
      "status": "active",
      "created_at": "2026-06-04T14:32:11.000Z",
      "expires_at": "2026-06-20T09:00:00.000Z",
      "short_code": "X7K2QP",
      "scan_status": "clean",
      "max_downloads": 50,
      "transfer_title": "Contrat de cession - Projet Atlas",
      "encryption_mode": "e2e",
      "recipient_email": "client@example.com",
      "total_downloads": 12,
      "watermark_enabled": false,
      "is_password_protected": true
    }
  ],
  "note": null,
  "count": 1,
  "format": "json",
  "object": "list",
  "limit_reached": false
}

Cet endpoint produit un export en masse de tous les transferts du workspace courant, destiné aux usages analytiques et de reporting. Les transferts sont retournés triés par date de création décroissante (les plus récents d'abord) et restreints au workspace résolu par la clé API. La requête est plafonnée par un paramètre limit (1000 par défaut, 10000 maximum) pour borner le coût : si le plafond est atteint, la réponse le signale explicitement via limit_reached et un champ note. Cet endpoint est classé expensive côté quota de débit, il consomme donc le budget de requêtes le plus restrictif.

Authentification

Cet endpoint exige une clé API valide portant le scope transfers:read. Le scope transfers:* (wildcard de ressource) ainsi que le wildcard global * satisfont également cette exigence. Présentez la clé via l'en-tête Authorization: Bearer cof_live_... (ou cof_test_...). En l'absence d'en-tête Bearer, l'authentification de session (cookie du tableau de bord) est acceptée et confère des scopes complets.

Paramètres de requête

Réponse

En mode JSON (par défaut), la réponse est un objet { object: "list", format: "json", data, count, limit_reached, note }. Le tableau data contient les transferts avec les champs suivants par enregistrement : id, short_code, transfer_title, status, expires_at, max_downloads, total_downloads, scan_status, encryption_mode, is_password_protected, watermark_enabled, recipient_email et created_at. Le champ count reflète le nombre de lignes retournées, limit_reached vaut true lorsque le nombre de lignes égale exactement le limit demandé, et note fournit alors un message d'aide (sinon null).

En mode CSV (format=csv), la réponse n'est pas du JSON : le corps est un texte CSV (Content-Type: text/csv; charset=utf-8) servi en pièce jointe via Content-Disposition: attachment; filename="coffrify-transfers-AAAA-MM-JJ.csv". La première ligne contient les en-têtes de colonnes (mêmes clés que les champs JSON), chaque valeur étant échappée entre guillemets. Si aucun transfert ne correspond, le corps CSV est vide.

Erreurs

Voir aussi

• GET /v1/transfers — lister les transferts avec pagination par curseur (usage temps réel).
• GET /v1/transfers/{id} — récupérer le détail d'un transfert unique.
• Référence des limites de débit pour les quotas des endpoints expensive.