Lister les documents d'une data-room

Renvoie la liste des transferts rattachés à une data-room donnée.

Réponse exemple

{
  "data": [
    {
      "id": "trf_9fQ2mK7",
      "status": "active",
      "created_at": "2026-06-01T09:14:32.000Z",
      "expires_at": "2026-07-01T00:00:00.000Z",
      "short_code": "a1B2c3D4",
      "max_downloads": 50,
      "allow_download": true,
      "transfer_title": "Comptes consolidés 2025",
      "total_downloads": 12
    },
    {
      "id": "trf_3xZ8nP1",
      "status": "active",
      "created_at": "2026-05-28T16:02:11.000Z",
      "expires_at": null,
      "short_code": "e5F6g7H8",
      "max_downloads": null,
      "allow_download": false,
      "transfer_title": "Cap table",
      "total_downloads": 3
    }
  ],
  "object": "list"
}

Renvoie l'ensemble des documents attachés à une data-room. Dans Coffrify, un document est un transfert (coffrify_transfers) rattaché à la room via son champ room_id. La room ciblée doit appartenir au workspace de la clé API appelante, sinon une erreur not_found est retournée. Les résultats sont triés par date de création décroissante (les documents les plus récents en premier).

GET/v1/rooms/{id}/documentsListe les transferts rattachés à la data-room {id}.

Authentification

Requiert une clé API valide disposant du scope rooms:read. La requête est portée par le header Authorization: Bearer <cle_api>. Le workspace est déduit de la clé : seules les rooms de ce workspace sont visibles.

Paramètres de chemin

Champ	Type	Requis	Description
id	string	oui	Identifiant de la data-room dont on liste les documents.

Réponse

La réponse est un objet de type liste : object vaut "list" et data contient un tableau de documents. Chaque entrée expose id, short_code (le code court du transfert), transfer_title, status, expires_at, total_downloads, max_downloads, allow_download et created_at. Si la room ne contient aucun document, data est un tableau vide.

Champ	Type	Description
object	string	Toujours "list".
data	array	Tableau des documents rattachés à la room.
data[].id	string	Identifiant interne du transfert.
data[].short_code	string	Code court du transfert, utilisé pour attacher/détacher.
data[].transfer_title	string	Titre du transfert.
data[].status	string	Statut du transfert (ex. active, expired).
data[].expires_at	string\|null	Date d'expiration (ISO 8601).
data[].total_downloads	number	Nombre total de téléchargements effectués.
data[].max_downloads	number\|null	Plafond de téléchargements, ou null si illimité.
data[].allow_download	boolean	Indique si le téléchargement est autorisé.
data[].created_at	string	Date de création (ISO 8601).

Erreurs

Code	Quand	Résolution
404 not_found	La room {id} n'existe pas ou n'appartient pas au workspace de la clé.	Vérifiez l'identifiant de la room et que la clé API cible le bon workspace.
403 scope_missing	La clé API ne possède pas le scope rooms:read.	Régénérez une clé incluant le scope rooms:read.
401 invalid_api_key	Clé API absente, invalide, expirée ou révoquée.	Vérifiez le header Authorization et la validité de la clé.
429 rate_limited	Quota de requêtes par minute du workspace dépassé.	Respectez l'en-tête Retry-After et lissez vos appels.
500 internal_error	Erreur lors de la lecture des transferts.	Réessayez ; si le problème persiste, contactez le support avec le request_id.

Voir aussi

POST /v1/rooms/{id}/documents — rattacher un transfert à la room
DELETE /v1/rooms/{id}/documents — détacher un transfert de la room
GET /v1/rooms — lister les data-rooms du workspace