Référence de l'API

Modèles

Des documents réutilisables avec des rôles. Créez-les dans l'application, puis envoyez-les avec l'API.

Points de terminaison · 2

GET Lister les modèles
GET Récupérer un modèle

L'objet

Champ	Saisir	Description
`id`	string	Identifiant unique, commençant par tpl_.
`object`	string	Toujours "template".
`name`	string	Le nom du modèle.
`message`	string	Le message par défaut.
`signing_order`	enum	sequential ou parallel.
`files, page_count`		Comme pour les documents.
`roles`	array	Chacun avec template_role (à remplir à l'envoi), role (signer ou cc), fixed_email (défini quand le rôle va toujours à la même adresse) et signing_order.
`folder_id`	string ou null	Son classeur.
`created_at, updated_at`	timestamp

GET/templates

Lister les modèles

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/templates" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Réponse

json

{
  "object": "list",
  "data": [
    {
      "id": "tpl_2zg4mZaouqKLiMcVbpT4r5",
      "object": "template",
      "name": "Mutual NDA",
      "message": "Please sign the NDA before our call.",
      "signing_order": "sequential",
      "files": [
        { "id": "file_1wQy0bN5bYc8xV0kH4mZtR", "name": "Mutual NDA.pdf", "content_type": "application/pdf", "size": 96420, "page_count": 3 }
      ],
      "page_count": 3,
      "roles": [
        { "template_role": "Client", "role": "signer", "fixed_email": null, "signing_order": 1 },
        { "template_role": "Account manager", "role": "signer", "fixed_email": null, "signing_order": 2 }
      ],
      "folder_id": null,
      "created_at": "2026-10-12T16:20:03.000Z",
      "updated_at": "2026-10-12T16:31:47.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

GET/templates/{id}

Récupérer un modèle

Pour l'envoyer, voyez Créer un document à partir d'un modèle.

Requête

bash

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

Réponse

json

{
  "id": "tpl_2zg4mZaouqKLiMcVbpT4r5",
  "object": "template",
  "name": "Mutual NDA",
  "message": "Please sign the NDA before our call.",
  "signing_order": "sequential",
  "files": [
    { "id": "file_1wQy0bN5bYc8xV0kH4mZtR", "name": "Mutual NDA.pdf", "content_type": "application/pdf", "size": 96420, "page_count": 3 }
  ],
  "page_count": 3,
  "roles": [
    { "template_role": "Client", "role": "signer", "fixed_email": null, "signing_order": 1 },
    { "template_role": "Account manager", "role": "signer", "fixed_email": null, "signing_order": 2 }
  ],
  "folder_id": null,
  "created_at": "2026-10-12T16:20:03.000Z",
  "updated_at": "2026-10-12T16:31:47.000Z"
}