AperçuRéférence
Référence API v1

Tous les endpoints, une seule page d'index.

270 endpoints documentés, regroupés en 36 sections fonctionnelles. Chaque fiche détaille les paramètres, codes d'erreur et fournit des exemples curl, Node et Python.

Alertes

4 endpoints

Analytics

6 endpoints

Approbations

6 endpoints

Audit

2 endpoints

Changelog

2 endpoints

Clés API

7 endpoints

Coffres

14 endpoints
GET/v1/coffres
Lister les coffres

Renvoie la liste des coffres du workspace, du plus récent au plus ancien.

POST/v1/coffres
Créer un coffre

Crée un coffre, avec protection par mot de passe, NDA et vérification e-mail optionnelles.

GET/v1/coffres/{id}
Récupérer un coffre

Renvoie un coffre avec ses sections et ses éléments, organisés hiérarchiquement.

PATCH/v1/coffres/{id}
Mettre à jour un coffre

Modifie un ou plusieurs champs d'un coffre existant.

DEL/v1/coffres/{id}
Supprimer un coffre

Supprime définitivement un coffre, ses sections, ses éléments et ses logs d'accès.

POST/v1/coffres/{id}/items
Ajouter un élément à un coffre

Ajoute un élément (transfert, lien externe ou markdown) à un coffre.

GET/v1/coffres/{id}/sections
Lister les sections d'un coffre

Récupère toutes les sections d'un coffre, ordonnées par position croissante.

POST/v1/coffres/{id}/sections
Créer une section dans un coffre

Ajoute une nouvelle section à un coffre, avec positionnement automatique en fin de liste si aucune position n'est fournie.

PATCH/v1/coffres/{id}/sections
Mettre à jour une section d'un coffre

Modifie le titre, la description, la visibilité ou la position d'une section existante, identifiée par section_id dans le corps.

DEL/v1/coffres/{id}/sections
Supprimer une section d'un coffre

Supprime une section et détache ses éléments en les rendant orphelins plutôt que de les supprimer.

GET/v1/coffres/{id}/guests
Lister les invités d'un coffre

Renvoie tous les invités actifs (non révoqués) d'un coffre du workspace.

POST/v1/coffres/{id}/guests
Inviter un invité sur un coffre

Crée (ou réémet) une invitation par e-mail et renvoie un lien d'accès au coffre.

DEL/v1/coffres/{id}/guests
Révoquer un invité d'un coffre

Passe un invité au statut révoqué pour lui retirer l'accès au coffre.

PATCH/v1/coffres/{id}/guests
Modifier un invité d'un coffre

Met à jour les permissions, la note ou l'expiration d'un invité existant.

Collections

11 endpoints

Data Rooms

14 endpoints
GET/v1/workspace/datarooms
Lister les data rooms du workspace

Retourne la liste paginée des data rooms M&A du workspace courant, enrichies des compteurs de viewers, documents et de la dernière activité.

POST/v1/workspace/datarooms
Créer une data room et inviter des viewers

Crée une data room M&A dans le workspace courant, attache éventuellement des documents et envoie des invitations par email aux viewers fournis.

GET/v1/workspace/datarooms/{id}/audit/export.csv
Exporter le journal d'audit d'une data room en CSV

Télécharge en un fichier CSV l'ensemble des consultations (vues) d'une data room, avec adresses IP anonymisées, pour l'audit vendor.

GET/v1/workspace/datarooms/{id}/audit/heatmap
Heatmap d'audit d'une Data Room

Renvoie la matrice de consultation viewers x documents d'une Data Room, avec tops, timeline 30 jours et totaux, sans exposer d'IP ni de User-Agent.

GET/v1/workspace/datarooms/{id}
Récupérer le détail d'une data room

Retourne une data room M&A du workspace courant avec ses statistiques agrégées (viewers, documents, questions, dernière activité).

PATCH/v1/workspace/datarooms/{id}
Mettre à jour une data room

Modifie le nom, la société cible, la description, le statut, l'expiration ou la NDA d'une data room du workspace, avec contrôle de quota à l'activation.

PATCH/v1/workspace/datarooms/{id}/viewers/{viewerId}
Mettre à jour ou révoquer un visiteur de data room

Révoque l'accès d'un visiteur (magic-link) ou met à jour ses métadonnées (nom, société, fonction) dans une data room du workspace.

POST/v1/workspace/datarooms/{id}/viewers/{viewerId}/resend
Renvoyer le lien d'accès d'un viewer de data room

Régénère un nouveau magic-link pour un viewer existant et renvoie l'email d'invitation à la data room.

GET/v1/workspace/datarooms/{id}/viewers
Lister les viewers d'une data room

Renvoie la liste de tous les viewers invites sur une data room du workspace actif.

POST/v1/workspace/datarooms/{id}/viewers
Inviter un viewer sur une data room

Ajoute un viewer à une data room et lui envoie une invitation par email avec un lien magique.

DEL/v1/workspace/datarooms/{id}/documents/{docId}
Supprimer un document de data room

Supprime définitivement un document d'une data room du workspace et journalise l'action dans l'audit de conformité.

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.

POST/v1/workspace/datarooms/{id}/documents
Ajouter un document à une data room

Rattache un fichier (coffre, transfert ou upload) à une data room et l'ajoute en fin de liste.

PATCH/v1/workspace/datarooms/{id}/questions/{questionId}
Répondre à une question de Data Room

Permet à un membre du workspace de répondre à une question Q&A d'une Data Room, en option de la rendre publique ou de clôturer le fil.

Demandes

7 endpoints

Destinataires

6 endpoints

Diagnostics

8 endpoints

Domaines

6 endpoints

Dossiers

4 endpoints

Facturation

7 endpoints

Intake

7 endpoints

Magic links

3 endpoints

Marque blanche

3 endpoints

MCP

11 endpoints
GET/v1/mcp/tokens
Lister les tokens MCP

Renvoie les tokens MCP du workspace, utilisés par les clients IA (Claude, Cursor, etc.).

POST/v1/mcp/tokens
Créer un token MCP

Génère un token MCP. Le token complet n'est affiché qu'une seule fois.

POST/v1/mcp/tokens/{id}/rotate
Faire tourner un token MCP

Crée un token de remplacement identique, avec une période de grâce avant révocation de l'ancien.

DEL/v1/mcp/tokens/{id}
Révoquer un token MCP

Désactive immédiatement un token MCP, avec une raison optionnelle.

GET/v1/mcp/tools
Lister les outils MCP

Renvoie le catalogue des outils exposés par le serveur MCP, avec les surcharges du workspace.

GET/v1/mcp/hosted/{workspaceId}
Inspecter le point d'accès MCP hébergé du workspace

Retourne l'état de santé, les URLs de transport et le catalogue d'outils du serveur MCP hébergé pour un workspace donné.

POST/v1/mcp/hosted/{workspaceId}
Dialoguer en JSON-RPC avec le serveur MCP hébergé

Traite les messages JSON-RPC MCP (initialize, tools/list, ping) pour le serveur hébergé du workspace.

GET/v1/mcp/custom-actions
Lister les actions personnalisées MCP

Récupère toutes les actions personnalisées MCP définies dans le workspace courant.

POST/v1/mcp/custom-actions
Créer une action personnalisée MCP

Crée une action personnalisée MCP (relais d'endpoint JSON ou code TypeScript) dans le workspace courant.

PATCH/v1/mcp/custom-actions/{id}
Modifier une action MCP personnalisée

Met à jour partiellement une action MCP personnalisée du workspace identifiée par son id.

DEL/v1/mcp/custom-actions/{id}
Supprimer une action MCP personnalisée

Supprime définitivement une action MCP personnalisée du workspace identifiée par son id.

Membres

7 endpoints

MFA

5 endpoints

Modèles

6 endpoints

Notifications

8 endpoints

Quotas & stockage

8 endpoints

Recherche

1 endpoints

Règles

6 endpoints

RGPD

6 endpoints

Rooms

11 endpoints

SCIM

4 endpoints

Sessions

4 endpoints

SSO

7 endpoints

Statut

3 endpoints

Tokens d'upload

3 endpoints

Transferts

23 endpoints
GET/v1/transfers
Lister les transferts

Renvoie la liste paginée des transferts du workspace, avec filtres et pagination par curseur.

POST/v1/transfers
Créer un transfert

Crée un transfert chiffré et renvoie les URL d'upload présignées pour chaque fichier.

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

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

DEL/v1/transfers/{id}
Révoquer un transfert

Révoque et supprime définitivement un transfert, bloquant tout accès ultérieur.

GET/v1/transfers/{id}/files
Lister les fichiers d'un transfert

Liste tous les fichiers attachés à un transfert, avec leur taille et leur type.

POST/v1/transfers/{id}/download-url
Générer une URL de téléchargement

Génère des URL présignées côté serveur, sans incrémenter le compteur de téléchargements.

POST/v1/transfers/{id}/extend
Prolonger un transfert

Repousse la date d'expiration d'un transfert, dans la limite de rétention du plan.

POST/v1/transfers/resolve
Résoudre un transfert depuis une URL ou un code court

Retrouve les métadonnées et l'état de cycle de vie d'un transfert à partir d'une URL de partage publique ou d'un code court, à condition qu'il appartienne au workspace appelant.

GET/v1/transfers/export
Exporter les transferts

Exporte en masse les transferts du workspace au format JSON ou CSV, plafonné pour les usages analytiques.

PUT/v1/transfers/{id}/password
Définir ou modifier le mot de passe d'un transfert

Protège un transfert par mot de passe (ou met à jour un mot de passe existant) en activant la protection à l'accès.

DEL/v1/transfers/{id}/password
Retirer le mot de passe d'un transfert

Supprime la protection par mot de passe d'un transfert et le rend accessible sans saisie.

GET/v1/transfers/{id}/replies
Lister les réponses sécurisées d'un transfert

Récupère les réponses sécurisées (jusqu'à 50) reçues sur un transfert dont vous êtes le propriétaire.

PUT/v1/transfers/{id}/folder
Classer un transfert dans un dossier

Assigne un transfert existant à un dossier du workspace.

DEL/v1/transfers/{id}/folder
Retirer un transfert de son dossier

Déclasse un transfert en remettant son dossier à null.

POST/v1/transfers/{id}/rescan
Relancer l'analyse antivirus d'un transfert

Replace un transfert dans la file d'analyse antivirus en repassant son statut de scan à `pending`.

GET/v1/transfers/{id}/approvers
Lister les approbateurs d'un transfert

Renvoie la liste des approbateurs attachés à un transfert, avec leur décision et leurs horodatages.

POST/v1/transfers/{id}/approvers
Ajouter un approbateur à un transfert

Ajoute un approbateur (par e-mail ou utilisateur interne) à un transfert et lui envoie une demande de validation par e-mail.

GET/v1/transfers/{id}/qrcode
Générer le QR code d'un transfert

Renvoie l'URL de partage d'un transfert et un QR code PNG prêt à l'emploi pointant vers cette URL.

POST/v1/transfers/{id}/approve
Approuver ou rejeter un transfert

Statue sur un transfert soumis à approbation en l'approuvant ou en le rejetant.

POST/v1/transfers/{id}/clone
Cloner un transfert

Duplique un transfert existant avec un nouveau short_code, un compteur de téléchargements remis à zéro, et réutilise les fichiers d'origine sans nouvel upload.

GET/v1/transfers/{id}/timeline
Récupérer la timeline d'un transfert

Renvoie la chronologie agrégée et triée de tous les événements survenus sur un transfert (création, scans, téléchargements, liens magiques, webhooks, audit).

GET/v1/transfers/{id}/downloads
Lister les téléchargements d'un transfert

Récupère la liste paginée des évènements de téléchargement enregistrés pour un transfert donné.

POST/v1/transfers/{id}/email
Renvoyer l'e-mail de partage d'un transfert

Renvoie (ou envoie à un nouveau destinataire) l'e-mail de partage d'un transfert existant.

Webhooks

18 endpoints
GET/v1/webhooks
Lister les webhooks

Renvoie tous les endpoints webhook enregistrés pour le workspace.

POST/v1/webhooks
Créer un webhook

Enregistre un endpoint webhook signé. Le secret de signature n'est renvoyé qu'une fois.

PATCH/v1/webhooks/{id}
Mettre à jour un webhook

Modifie l'URL, les événements souscrits, l'état actif ou la politique de retry.

DEL/v1/webhooks/{id}
Supprimer un webhook

Supprime définitivement un endpoint webhook.

POST/v1/webhooks/{id}/test
Tester un webhook

Envoie un événement de test à l'URL du webhook et renvoie la réponse HTTP reçue.

GET/v1/webhooks/event-catalog
Lister le catalogue d'événements webhook

Retourne le catalogue complet des types d'événements webhook supportés par Coffrify, groupés par famille.

GET/v1/webhooks/health
Statistiques de santé des webhooks

Renvoie le taux de succès, la répartition des statuts de livraison et les latences p50/p95/p99 par webhook sur une fenêtre temporelle.

GET/v1/webhooks/events/by-family
Lister les événements webhook par famille

Filtre le catalogue d'événements webhook par famille et renvoie le décompte d'événements pour chaque famille.

GET/v1/webhooks/events
Lister les types d'événements webhook

Retourne le catalogue complet des types d'événements webhook supportés par Coffrify, avec leur famille, description et plan requis.

POST/v1/webhooks/{id}/simulate
Simuler un événement webhook

Envoie au point de réception d'un webhook un événement de test au type et au payload choisis pour valider la prise en charge d'une forme d'événement précise.

POST/v1/webhooks/{id}/rotate-secret
Faire pivoter le secret de signature d'un webhook

Génère un nouveau secret de signature pour un webhook tout en laissant l'ancien valide pendant une fenêtre de grâce configurable.

GET/v1/webhooks/{id}/secret-status
Consulter l'état du secret de signature d'un webhook

Renvoie un résumé non sensible de l'état du secret de signature d'un webhook (préfixe, dernière rotation, fenêtre de grâce) sans jamais exposer la valeur du secret.

GET/v1/webhooks/{id}/deliveries
Lister les livraisons d'un webhook

Récupère l'historique paginé des tentatives de livraison d'un endpoint webhook, de la plus récente à la plus ancienne.

GET/v1/webhooks/deliveries/abandoned
Lister les livraisons de webhooks abandonnées

Retourne la dead-letter queue des livraisons de webhooks qui ont épuisé leur budget de réessais, avec des recommandations d'action par endpoint.

GET/v1/webhooks/deliveries/search
Rechercher les livraisons de webhooks

Recherche transversale des livraisons de webhooks récentes du workspace, avec filtres par événement, statut, webhook et date.

POST/v1/webhooks/deliveries/{id}/retry
Relancer une livraison de webhook échouée

Force la remise en file d'une livraison de webhook bloquée en échec en remettant son compteur de tentatives à zéro.

GET/v1/webhooks/deliveries/{id}
Récupérer une livraison de webhook

Renvoie le détail complet d'une tentative de livraison de webhook, payload signé et réponse HTTP du endpoint inclus.

POST/v1/webhooks/deliveries/{id}/replay
Rejouer une livraison de webhook

Renvoie une livraison de webhook passée vers la même URL en conservant l'event_id d'origine pour la déduplication.

Workspace

22 endpoints
GET/v1/workspace/profile
Profil du workspace

Renvoie le profil du workspace.

GET/v1/workspace/settings
Paramètres du workspace

Renvoie les paramètres du workspace.

PATCH/v1/workspace/settings
Modifier les paramètres

Met à jour les paramètres du workspace.

GET/v1/workspace/activity
Activité du workspace

Renvoie le flux d'activité du workspace.

GET/v1/me
Identité de la clé

Renvoie le contexte d'authentification de la clé courante.

POST/v1/workspace/capability-requests
Demander une capability de workspace

Un membre admin demande une capability sensible (facturation, suppression, gestion des membres ou des réglages) que l'owner du compte propriétaire approuvera ensuite.

GET/v1/workspace/capability-requests
Lister les demandes de capability en attente

Récupère les demandes de capability au statut « pending » d'un workspace : l'owner voit toutes les demandes, un membre ne voit que les siennes.

PATCH/v1/workspace/capability-requests/{id}
Approuver ou refuser une demande de capability

Le propriétaire du compte approuve ou refuse une demande de capability d'un membre du workspace, avec confirmation MFA à l'approbation.

GET/v1/workspace/stats-by-member
Statistiques d'activité par membre

Retourne, pour chaque membre du workspace, l'activité agrégée des N derniers jours (transferts, stockage produit, téléchargements, événements d'audit).

POST/v1/workspace/clone-config
Cloner la configuration d'un espace de travail

Copie le branding, les webhooks, les modèles, les règles et les notifications d'un espace de travail source vers un espace de travail cible que vous possédez.

GET/v1/workspace/health
Score de santé du workspace

Renvoie un score composite de 0 à 100 avec un détail par dimension de sécurité et des actions recommandées pour le workspace authentifié.

DEL/v1/workspace/transfer-ownership/{id}
Annuler un transfert de propriété d'espace

Annule un transfert de propriété d'espace en attente, avant que le destinataire ne l'ait accepté.

PATCH/v1/workspace/members/{memberId}
Mettre à jour un membre du workspace

Modifie le rôle et les permissions (capabilities) d'un membre du workspace.

DEL/v1/workspace/members/{memberId}
Retirer un membre du workspace

Supprime définitivement un membre du workspace actif.

GET/v1/workspace/members
Lister les membres de l'espace de travail

Renvoie tous les membres (actifs et invitations en attente) de l'espace de travail actif, avec leurs rôles et capacités.

POST/v1/workspace/members
Inviter un membre dans l'espace de travail

Crée une invitation par e-mail dans l'espace de travail actif, avec rôle et capacités optionnelles, et envoie le lien d'acceptation.

GET/v1/workspace/audit-summary
Récapitulatif du journal d'audit

Renvoie un résumé agrégé du journal d'audit du workspace sur une fenêtre temporelle glissante, avec les acteurs et actions les plus fréquents et la détection d'anomalies.

GET/v1/welcome
Point d'entree de l'API (welcome)

Renvoie les metadonnees publiques de l'API Coffrify : version, liens de documentation, SDK, mode d'authentification, quotas de debit et conventions d'en-tetes.

GET/v1/workspaces
Lister les espaces de travail

Retourne la liste des espaces de travail accessibles à l'appelant, sous forme d'objet de type liste.

POST/v1/workspaces/switch
Changer le workspace actif

Définit le workspace actif de l'utilisateur après vérification de son accès (propriétaire ou membre).

POST/v1/me/acquisition
Enregistrer l'attribution d'acquisition

Estampille la source d'acquisition first-touch et l'identifiant visiteur anonyme sur le profil de l'utilisateur connecté, de façon idempotente.

POST/v1/me/language
Définir ma langue préférée

Persiste la langue préférée de l'utilisateur connecté pour les communications, notamment les emails.