Se connecterCommencer gratuitement
Référence APILister les sections d'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.

1 min de lectureTélécharger en PDF

Réponse exemple

{
  "data": [
    {
      "id": "sec_8f2a1c4e",
      "title": "Documents juridiques",
      "position": 0,
      "coffre_id": "cof_3b9d7e21",
      "created_at": "2026-05-20T09:14:03.000Z",
      "is_visible": true,
      "description": "Statuts, pactes et procès-verbaux"
    },
    {
      "id": "sec_a71b9d02",
      "title": "États financiers",
      "position": 1,
      "coffre_id": "cof_3b9d7e21",
      "created_at": "2026-05-20T09:16:48.000Z",
      "is_visible": true,
      "description": null
    }
  ],
  "object": "list"
}
GET/v1/coffres/{id}/sectionsListe les sections du coffre identifié par {id}, triées par position croissante.

Renvoie l'ensemble des sections rattachées au coffre {id}. Les sections structurent le contenu d'un coffre en regroupant les éléments (items) sous des intitulés thématiques. Avant la lecture, l'appartenance du coffre au workspace de la clé API est vérifiée : un coffre qui n'appartient pas au workspace renvoie une 404 même s'il existe. Les sections sont toujours retournées dans l'ordre de leur champ position, du plus petit au plus grand.

Authentification

Cet endpoint exige une clé API valide portant le scope transfers:read. Un jeton dépourvu de ce scope reçoit une erreur 403 scope_missing. Les scopes plus larges (par exemple transfers:write ou le wildcard *) satisfont également l'exigence via le mécanisme d'alias de scopes.

Paramètres de requête

Le seul paramètre est l'identifiant du coffre, transmis dans le chemin de l'URL.

ChampTypeRequisDescription
idstringOuiIdentifiant du coffre, extrait du chemin (/v1/coffres/{id}/sections). Un identifiant manquant déclenche une erreur 400 validation_error.

Réponse

La réponse est une enveloppe de liste : object vaut "list" et data contient un tableau de sections (vide si aucune section). Chaque section expose id, coffre_id, title, description (peut être null), position (entier d'ordre), is_visible (booléen) et created_at (horodatage ISO 8601).

ChampTypeDescription
objectstringToujours "list" pour cette enveloppe.
dataarrayTableau des sections triées par position croissante.
data[].idstringIdentifiant unique de la section.
data[].coffre_idstringIdentifiant du coffre parent.
data[].titlestringIntitulé de la section.
data[].descriptionstring | nullDescription optionnelle de la section.
data[].positionintegerRang d'affichage (ordre croissant).
data[].is_visiblebooleanIndique si la section est visible côté destinataire.
data[].created_atstringDate de création (ISO 8601).

Erreurs

CodeQuandRésolution
400 validation_errorIdentifiant de coffre absent du chemin.Vérifiez que l'URL contient bien un {id} de coffre.
401 invalid_api_keyClé API absente, mal formée ou non reconnue.Fournissez une clé valide dans l'en-tête Authorization.
403 scope_missingLe jeton ne porte pas le scope transfers:read.Émettez une clé incluant transfers:read.
404 not_foundLe coffre n'existe pas ou n'appartient pas au workspace.Vérifiez l'identifiant du coffre et le workspace de la clé.
429 rate_limitedQuota de requêtes par minute dépassé.Respectez l'en-tête Retry-After et réessayez ensuite.
500 internal_errorErreur interne lors de la lecture en base.Réessayez ; si le problème persiste, contactez le support avec le request_id.

Voir aussi