Référence de l'API

Dossiers

Regroupez les documents dans des classeurs, partagés dans tout l'espace de travail.

Points de terminaison · 6

POST Créer un dossier
GET Récupérer un dossier
GET Lister les dossiers
PATCH Renommer un classeur
DELETE Supprimer un dossier
POST Déplacer des documents dans un dossier

L'objet

Champ	Saisir	Description
`id`	string	Identifiant unique, commençant par fdr_.
`object`	string	Toujours "folder".
`name`	string	Unique dans l'espace de travail.
`document_count`	integer	Documents dans le classeur.
`created_at`	timestamp

POST/folders

Créer un dossier

Paramètre	Saisir		Description
`name`	string	obligatoire	Jusqu'à 80 caractères.

Requête

bash

curl -X POST "https://api.esorasign.com/v1/folders" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Client contracts" }'

Réponse

json

{
  "id": "fdr_6TMAd7V3DnI8lFPPwtV5AS",
  "object": "folder",
  "name": "Client contracts",
  "document_count": 0,
  "created_at": "2026-08-04T09:00:12.000Z"
}

GET/folders/{id}

Récupérer un dossier

Requête

bash

curl "https://api.esorasign.com/v1/folders/fdr_6TMAd7V3DnI8lFPPwtV5AS" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Réponse

json

{
  "id": "fdr_6TMAd7V3DnI8lFPPwtV5AS",
  "object": "folder",
  "name": "Client contracts",
  "document_count": 14,
  "created_at": "2026-08-04T09:00:12.000Z"
}

GET/folders

Lister les dossiers

Les plus récents d'abord.

Paramètre	Saisir		Description
`limit`	integer	facultatif	Nombre d'objets à renvoyer, de 1 à 100. Par défaut 20.
`starting_after`	string	facultatif	Le next_cursor de la page précédente. Omettez-le pour la première page.

Requête

bash

curl "https://api.esorasign.com/v1/folders" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Réponse

json

{
  "object": "list",
  "data": [
    {
      "id": "fdr_6TMAd7V3DnI8lFPPwtV5AS",
      "object": "folder",
      "name": "Client contracts",
      "document_count": 14,
      "created_at": "2026-08-04T09:00:12.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

PATCH/folders/{id}

Renommer un classeur

Paramètre	Saisir		Description
`name`	string	obligatoire

Requête

bash

curl -X PATCH "https://api.esorasign.com/v1/folders/fdr_6TMAd7V3DnI8lFPPwtV5AS" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Clients" }'

Réponse

json

{
  "id": "fdr_6TMAd7V3DnI8lFPPwtV5AS",
  "object": "folder",
  "name": "Client contracts",
  "document_count": 14,
  "created_at": "2026-08-04T09:00:12.000Z"
}

DELETE/folders/{id}

Supprimer un dossier

Ses documents sont conservés et sortent du classeur.

Requête

bash

curl -X DELETE "https://api.esorasign.com/v1/folders/fdr_6TMAd7V3DnI8lFPPwtV5AS" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Réponse

json

{ "id": "fdr_6TMAd7V3DnI8lFPPwtV5AS", "object": "folder", "deleted": true }

POST/folders/{id}/documents

Déplacer des documents dans un dossier

Paramètre	Saisir		Description
`document_ids`	array	obligatoire	De 1 à 100 identifiants de documents.

Requête

bash

curl -X POST "https://api.esorasign.com/v1/folders/fdr_6TMAd7V3DnI8lFPPwtV5AS/documents" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "document_ids": ["doc_3y9Pf34qY6Nb3wWD25RQ4F"] }'

Réponse

json

{ "object": "folder_move", "folder_id": "fdr_6TMAd7V3DnI8lFPPwtV5AS", "moved": 1 }