Référence APILister les documents d'une data room
GET/v1/workspace/datarooms/{id}/documents

Lister les documents d'une data room

Récupère la liste ordonnée des documents rattachés à une data room du workspace courant.

1 min de lectureTélécharger en PDF

Réponse exemple

{
"data": [
{
"id": "7c1f0a2e-5b3d-4f9a-8c10-2e6b9d4f1a33",
"title": "Pacte d'associés 2026.pdf",
"sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"added_by": "e1a0c3b2-4d5e-6f70-8192-a3b4c5d6e7f8",
"mime_type": "application/pdf",
"source_id": "d9f4c2a1-7e8b-4c3a-9d20-5f1e8b2c6a90",
"size_bytes": 482301,
"dataroom_id": "a4e2b8d1-9f3c-4a7e-bb20-1c5d7e9a3f44",
"description": "Version signée du pacte",
"order_index": 0,
"source_type": "vault_file",
"watermark_required": true
},
{
"id": "1b2c3d4e-5f60-7081-92a3-b4c5d6e7f809",
"title": "États financiers Q1.xlsx",
"sha256": null,
"added_by": "e1a0c3b2-4d5e-6f70-8192-a3b4c5d6e7f8",
"mime_type": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
"source_id": "c0d1e2f3-a4b5-6c7d-8e9f-0a1b2c3d4e5f",
"size_bytes": 120044,
"dataroom_id": "a4e2b8d1-9f3c-4a7e-bb20-1c5d7e9a3f44",
"description": null,
"order_index": 1,
"source_type": "transfer_file",
"watermark_required": true
}
],
"object": "list"
}
GET/v1/workspace/datarooms/{id}/documentsListe les documents d'une data room, triés par ordre d'affichage.

Renvoie l'ensemble des documents rattachés à la data room identifiée par {id}, triés par order_index croissant (l'ordre d'affichage défini lors de l'ajout). La réponse est limitée à 500 documents. La data room doit appartenir au workspace actif de l'utilisateur ; à défaut, une erreur 404 est retournée afin de ne pas divulguer l'existence de la ressource.

Authentification

Cet endpoint s'appuie sur la session Supabase (cookie de connexion) et non sur un scope de clé API : aucun scope spécifique n'est requis, mais une session utilisateur valide est obligatoire. Le workspace ciblé est déterminé par le cookie cf-workspace-id (sinon le premier workspace actif de l'utilisateur). L'utilisateur doit être membre actif de ce workspace ; la lecture est ouverte à tous les rôles membres.

Paramètres de requête

ParamètreTypeRequisDescription
idstring (UUID, chemin)ouiIdentifiant de la data room dont on liste les documents.

Réponse

Un objet d'enveloppe { object: "list", data: [...] }. Chaque élément de data est une ligne complète de coffrify_dataroom_documents : id, dataroom_id, source_type (vault_file, transfer_file ou upload), source_id (UUID vault/transfert ou clé d'objet), title, description, order_index, mime_type, size_bytes, sha256, watermark_required et added_by.

Erreurs

CodeQuandRésolution
401Aucune session utilisateur valide (Unauthorized).Authentifiez l'utilisateur via une session Supabase active.
404Aucun workspace actif (No active workspace) ou data room introuvable / hors du workspace (Not found).Vérifiez l'appartenance au workspace et que {id} désigne bien une data room de ce workspace.
500Erreur de lecture en base.Réessayez ; si l'erreur persiste, contactez le support avec le message renvoyé.

Voir aussi