> ## Documentation Index
> Fetch the complete documentation index at: https://docs.firma.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Récupérer un Modèle

> Récupère un modèle spécifique par ID



## OpenAPI

````yaml api-reference/v01.30.00/openapi-v01.30.00.fr.json get /templates/{id}
openapi: 3.0.3
info:
  title: API Partenaire Firma
  description: >-
    API RESTful pour la signature de documents et la gestion de modèles.


    **Authentification** : Tous les endpoints nécessitent une authentification
    par clé API via l'en-tête `Authorization`. Utilisez votre clé API
    directement sans préfixe (par exemple, `your-api-key`). Le préfixe Bearer
    est optionnel mais pas obligatoire.


    **Fonctionnalités de sécurité** :

    - Validation des entrées avec des schémas Zod incluant des messages d'erreur
    détaillés au niveau des champs

    - Jetons JWT signés RSA-256 pour l'accès aux modèles intégrés


    **Limitation de débit** : Les limites de débit sont hiérarchisées selon le
    type d'opération :

    - Opérations de lecture (GET) : 200 requêtes par minute

    - Opérations d'écriture (POST/PUT/PATCH/DELETE) : 120 requêtes par minute

    - Opérations CRUD sur les webhooks : 60 requêtes par minute

    - Test de webhook : 10 requêtes par minute

    - Régénération/expiration de clé API : 1 requête par minute

    - Rotation du secret de webhook : 1 requête par minute


    Lorsque les limites de débit sont dépassées, l'API renvoie une réponse `429
    Too Many Requests` avec les en-têtes suivants :

    - `X-RateLimit-Limit` : Nombre maximal de requêtes par minute pour cet
    endpoint

    - `X-RateLimit-Remaining` : Requêtes restantes dans la fenêtre actuelle

    - `X-RateLimit-Reset` : Horodatage Unix de la réinitialisation de la limite

    - `Retry-After` : Secondes à attendre avant de pouvoir réessayer


    **Gestion des erreurs** : Toutes les erreurs renvoient des réponses JSON
    structurées avec `error` (message lisible par un humain), `code`
    (identifiant lisible par une machine) et `details` (erreurs de validation au
    niveau des champs, le cas échéant).


    **Intégration de l'Éditeur de Modèles intégré** : L'Éditeur de Modèles Firma
    peut être intégré dans votre application à l'aide d'une bibliothèque
    JavaScript autonome.


    ```html

    <!-- Charger la bibliothèque de l'Éditeur de Modèles Firma -->

    <script
    src="https://api.firma.dev/functions/v1/embed-proxy/template-editor.js"></script>


    <script>

    // Générer d'abord un jeton JWT via l'API

    fetch('https://api.firma.dev/functions/v1/signing-request-api/generate-template-token',
    {
      method: 'POST',
      headers: {
        'Authorization': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
      },
      body: JSON.stringify({
        companies_workspaces_templates_id: 'template-id'
      })
    })

    .then(res => res.json())

    .then(data => {
      // Initialiser l'éditeur avec le jeton JWT
      window.FirmaTemplateEditor.init({
        container: '#firma-editor-container',
        jwt: data.token,
        templateId: 'template-id',
        theme: 'dark',
        readOnly: false,
        onSave: (savedData) => {
          console.log('Template saved:', savedData);
        },
        onError: (error) => {
          console.error('Editor error:', error);
        },
        onLoad: (template) => {
          console.log('Template loaded:', template);
        }
      });
    });

    </script>

    ```
  version: 01.30.00
  contact:
    name: API Support
    url: https://firma.com/support
servers:
  - url: https://api.firma.dev/functions/v1/signing-request-api
    description: API de Production - Recommandée (Actuelle)
  - url: https://api.firma.dev/api/v1
    description: API de Production - Prévue
security:
  - ApiKeyAuth: []
tags:
  - name: Company
    description: Informations et paramètres de l'entreprise
  - name: Workspaces
    description: Opérations de gestion des Espaces de Travail
  - name: Templates
    description: Opérations de gestion des Modèles
  - name: Signing Requests
    description: Opérations de Demande de Signature de documents
  - name: Custom Fields
    description: >-
      Gestion des définitions de champs personnalisés pour les espaces de
      travail, modèles et demandes de signature
  - name: Webhooks
    description: Configuration et gestion des webhooks
  - name: JWT Management
    description: Génération et révocation de jetons JWT pour les modèles intégrés
  - name: Workspace Settings
    description: Configuration et paramètres de l'espace de travail
  - name: Email Domains
    description: >-
      Configuration et vérification de domaine e-mail pour l'envoi d'e-mails de
      demande de signature depuis des domaines personnalisés
  - name: Email Templates
    description: >-
      Gestion des modèles d'e-mail pour la personnalisation des notifications de
      demande de signature au niveau de l'espace de travail et de l'entreprise
  - name: Signer Terms
    description: >-
      Conditions d'utilisation / déclarations de consentement personnalisées
      pour le signataire, au niveau de l'entreprise avec des surcharges par
      espace de travail et par langue
paths:
  /templates/{id}:
    get:
      tags:
        - Templates
      summary: Récupérer un Modèle
      description: Récupère un modèle spécifique par ID
      operationId: getTemplate
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Modèle récupéré avec succès
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: 'Limite de taux : 200 requêtes par minute'
            X-RateLimit-Remaining:
              schema:
                type: integer
            X-RateLimit-Reset:
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Template'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '404':
          $ref: '#/components/responses/NotFoundError'
        '429':
          $ref: '#/components/responses/RateLimitError'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: TypeScript
          label: '@firma-dev/sdk'
          source: |-
            import { FirmaClient } from "@firma-dev/sdk";

            const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });

            const response = await firma.templates.getTemplate({
                id: "id"
            });
            console.log(response);
components:
  schemas:
    Template:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Identifiant unique du modèle
        name:
          type: string
          description: Nom du modèle
          maxLength: 255
        description:
          type: string
          description: Description du modèle
          nullable: true
        document_url:
          type: string
          format: uri
          description: >-
            URL pré-signée vers le document PDF. Il s'agit d'une URL signée à
            durée limitée pour un accès sécurisé, voir document_url_expires_at
            pour la date d'expiration. Les URL initiales sont valables 7 jours ;
            les URL rafraîchies sont valables 1 heure. Demandez une nouvelle
            récupération du modèle pour obtenir une URL fraîche si elle a
            expiré.
        document_url_expires_at:
          type: string
          format: date-time
          nullable: true
          description: >-
            Timestamp ISO 8601 auquel document_url expirera. Après cette heure,
            l'URL retournera une erreur d'accès refusé. Récupérez à nouveau le
            modèle pour recevoir une nouvelle URL signée.
        page_count:
          type: integer
          minimum: 1
          description: Nombre de pages dans le document
        expiration_hours:
          type: integer
          minimum: 1
          default: 168
          description: >-
            Nombre d'heures avant l'expiration des demandes de signature créées
            à partir de ce modèle
        credit_cost:
          type: integer
          minimum: 1
          default: 1
          description: >-
            Nombre de crédits consommés lorsqu'une demande de signature est
            envoyée à partir de ce modèle. La valeur minimale est 1.
        settings:
          $ref: '#/components/schemas/SigningRequestSettings'
        recipients:
          type: array
          items:
            $ref: '#/components/schemas/TemplateUser'
          description: >-
            Destinataires du modèle (inclus dans la récupération d'un seul
            modèle)
        fields:
          type: array
          items:
            $ref: '#/components/schemas/TemplateField'
          description: Champs du modèle (inclus dans la récupération d'un seul modèle)
        created_date:
          type: string
          format: date-time
          description: Timestamp de création du modèle
        updated_date:
          type: string
          format: date-time
          description: Timestamp de dernière mise à jour du modèle
      required:
        - id
        - name
        - created_date
    SigningRequestSettings:
      type: object
      description: >-
        Paramètres renvoyés par les endpoints de liste et de détail des demandes
        de signature. Les modèles utilisent le schéma TemplateSettings (sans
        champs d'identité).
      properties:
        allow_download:
          type: boolean
          description: Indique si les destinataires peuvent télécharger le document
          default: true
        attach_pdf_on_finish:
          type: boolean
          description: Indique s'il faut joindre le PDF une fois la signature terminée
          default: true
        allow_editing_before_sending:
          type: boolean
          description: Indique si la demande de signature peut être modifiée avant l'envoi
          default: false
        use_signing_order:
          type: boolean
          description: >-
            Indique si l'ordre de signature est imposé entre les destinataires.
            Quand c'est vrai, les signataires reçoivent le document dans l'ordre
            défini par leur order. Quand c'est faux, tous les signataires
            reçoivent le document simultanément.
          default: true
        hand_drawn_only:
          type: boolean
          description: >-
            Lorsque cette option est activée, les signataires ne peuvent que
            dessiner leur signature à la main et ne peuvent pas utiliser de
            signatures dactylographiées
          default: false
        send_signing_email:
          type: boolean
          description: >-
            Indique s'il faut envoyer des e-mails de notification de demande de
            signature aux signataires
          default: true
        send_finish_email:
          type: boolean
          description: >-
            Indique s'il faut envoyer un e-mail de fin lorsque tous les
            signataires ont terminé
          default: true
        send_expiration_email:
          type: boolean
          description: >-
            Indique s'il faut envoyer un e-mail de notification d'expiration
            quand la demande expire
          default: true
        send_cancellation_email:
          type: boolean
          description: >-
            Indique s'il faut envoyer un e-mail de notification d'annulation
            quand la demande est annulée
          default: true
        require_otp_verification:
          type: boolean
          nullable: true
          description: >-
            Indique si les signataires doivent vérifier leur e-mail avec un code
            à usage unique avant d'accéder au document. null = hérite du
            paramètre de l'espace de travail/de l'entreprise.
          default: null
        disable_guided_navigation:
          type: boolean
          nullable: true
          description: >-
            Désactive le défilement automatique vers le prochain champ requis
            pendant la signature. Hérite de l'espace de travail ou de
            l'entreprise si non défini.
        allow_presigning_download:
          type: boolean
          nullable: true
          description: >-
            Permet aux signataires de télécharger le document original avant de
            signer. Hérite du paramètre de l'espace de travail ou de
            l'entreprise quand null.
        show_qr_code:
          type: boolean
          nullable: true
          description: >-
            Affiche un QR code sur la page de signature qui permet aux
            signataires de continuer sur leur téléphone. Hérite du paramètre de
            l'espace de travail ou de l'entreprise quand null.
        identity_editable_fields:
          type: array
          nullable: true
          items:
            type: string
          description: >-
            Champs d'identité que les signataires peuvent modifier avant de
            signer (par exemple ["name", "company"]). null = désactivé. Quand
            c'est défini, une boîte de dialogue de confirmation permet aux
            signataires de modifier les champs spécifiés.
        notify_identity_change_email:
          type: boolean
          default: false
          description: >-
            Envoie une notification par e-mail quand un signataire modifie son
            identité.
    TemplateUser:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Identifiant unique de l'utilisateur du modèle
        name:
          type: string
          description: Nom du destinataire (prénom et nom combinés)
        email:
          type: string
          format: email
          description: Adresse e-mail du destinataire
        first_name:
          type: string
          nullable: true
          description: Prénom du destinataire
        last_name:
          type: string
          nullable: true
          description: Nom de famille du destinataire
        designation:
          type: string
          enum:
            - Signer
            - Approver
            - CC
          description: >-
            Rôle du destinataire. Signer signe le document, Approver approuve
            avec des champs d'approbation, CC reçoit une copie une fois terminé.
        order:
          type: integer
          minimum: 1
          description: Ordre dans lequel le destinataire doit signer
        phone_number:
          type: string
          nullable: true
          description: Numéro de téléphone du destinataire
        street_address:
          type: string
          nullable: true
          description: Adresse postale du destinataire
        city:
          type: string
          nullable: true
          description: Ville du destinataire
        state_province:
          type: string
          nullable: true
          description: État ou province du destinataire
        postal_code:
          type: string
          nullable: true
          description: Code postal du destinataire
        country:
          type: string
          nullable: true
          description: Pays du destinataire
        title:
          type: string
          nullable: true
          description: Intitulé de poste du destinataire
        company:
          type: string
          nullable: true
          description: Nom de l'entreprise du destinataire
        required_fields:
          type: array
          items:
            type: string
          description: >-
            Liste des champs de données du destinataire requis pour l'envoi
            (basée sur les champs du modèle avec des correspondances
            variable_name). Inclut toujours 'email' et 'first_name'.
        missing_fields:
          type: array
          items:
            type: string
          description: Liste des champs requis actuellement vides pour ce destinataire
        required_read_only_fields:
          type: array
          items:
            type: object
            properties:
              variable_name:
                type: string
                nullable: true
                description: Nom de variable du champ en lecture seule
              variable_defined_name:
                type: string
                nullable: true
                description: >-
                  Nom de champ lisible par un humain provenant de la définition
                  du champ personnalisé (par exemple 'artist_name'). Présent
                  uniquement pour les champs liés à une définition de champ
                  personnalisé, sinon null.
              field_type:
                type: string
                description: Type du champ (text, date, etc.)
          description: >-
            Liste des champs en lecture seule obligatoires qui nécessitent des
            valeurs préremplies avant l'envoi
        ready_to_send:
          type: boolean
          description: >-
            Indique si ce destinataire a toutes les données obligatoires
            renseignées pour l'envoi
      required:
        - id
        - first_name
        - email
        - designation
        - order
    TemplateField:
      type: object
      description: Un champ placé sur un document modèle
      properties:
        id:
          type: string
          format: uuid
          description: Identifiant unique du champ
        type:
          type: string
          enum:
            - text
            - signature
            - date
            - checkbox
            - dropdown
            - radio_buttons
            - number
            - text_area
            - file
            - initial
            - stamp
            - approval_signature
            - approval_checkmark
            - approval_date
          description: Type du champ
        required:
          type: boolean
          description: Indique si le champ est obligatoire
        recipient_id:
          type: string
          format: uuid
          nullable: true
          description: ID du destinataire assigné
        variable_name:
          type: string
          nullable: true
          description: Nom de variable pour le champ (utilisé dans les modèles)
        variable_defined_name:
          type: string
          nullable: true
          description: >-
            Nom de champ lisible par un humain provenant de la définition du
            champ personnalisé (par exemple 'artist_name'). Présent uniquement
            pour les champs liés à une définition de champ personnalisé, sinon
            null.
        position:
          type: object
          description: >-
            Position et dimensions du champ sur le document. Toutes les valeurs
            sont des pourcentages (0-100). Le champ doit tenir dans la page : x
            + width <= 100 et y + height <= 100.
          properties:
            x:
              type: number
              minimum: 0
              maximum: 100
              description: Coordonnée X de la position du champ (pourcentage, 0-100)
            'y':
              type: number
              minimum: 0
              maximum: 100
              description: Coordonnée Y de la position du champ (pourcentage, 0-100)
            width:
              type: number
              minimum: 0
              maximum: 100
              description: >-
                Largeur du champ (pourcentage, 0-100). Remarque : x + width doit
                être <= 100
            height:
              type: number
              minimum: 0
              maximum: 100
              description: >-
                Hauteur du champ (pourcentage, 0-100). Remarque : y + height
                doit être <= 100
        page_number:
          type: integer
          minimum: 1
          nullable: true
          description: >-
            Numéro de la page où se trouve le champ (indexé à partir de 1). Ne
            doit pas dépasser le nombre total de pages du document.
        dropdown_options:
          nullable: true
          description: Options pour les champs de type menu déroulant
          oneOf:
            - type: array
              items:
                type: string
            - type: object
        multi_group_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            ID de groupe pour lier plusieurs champs de case à cocher ou de
            bouton radio ensemble. Les champs partageant le même multi_group_id
            se comportent comme un groupe mutuellement exclusif (comme des
            boutons radio) : en sélectionner un désélectionne automatiquement
            les autres du groupe. Utilisez le même UUID sur plusieurs champs
            pour créer un groupe où une seule option peut être sélectionnée à la
            fois.
        date_default:
          type: string
          format: date
          nullable: true
          description: >-
            Valeur de date par défaut pour les champs de date (format ISO 8601,
            par exemple '2024-01-15')
        date_signing_default:
          type: boolean
          description: >-
            Utiliser la date de signature comme valeur par défaut pour les
            champs de date
        format_rules:
          $ref: '#/components/schemas/DateFormatRules'
          nullable: true
          description: >-
            Règles de formatage, actuellement utilisées pour les champs de date
            afin de spécifier le format d'affichage
        validation_rules:
          $ref: '#/components/schemas/FieldValidationRules'
        read_only:
          type: boolean
          default: false
          description: >-
            Indique si ce champ est en lecture seule (prérempli avant la
            signature)
        read_only_value:
          type: string
          nullable: true
          description: Valeur statique pour les champs en lecture seule
      required:
        - id
        - type
        - page_number
    Error:
      type: object
      properties:
        error:
          type: string
          description: Message d'erreur lisible par un humain
        message:
          type: string
          description: Description détaillée de l'erreur
        details:
          type: object
          description: Détails d'erreur supplémentaires
          additionalProperties: true
      required:
        - error
    DateFormatRules:
      type: object
      description: >-
        Règles de formatage pour les champs de date. Spécifie comment les
        valeurs de date doivent être affichées et formatées.
      properties:
        dateFormat:
          type: string
          description: >-
            Modèle de format de date. Utilisez des formats prédéfinis ou des
            modèles personnalisés avec : yyyy (année sur 4 chiffres), MM (mois
            sur 2 chiffres), dd (jour sur 2 chiffres), MMMM (nom complet du
            mois), MMM (nom abrégé du mois), HH (heure sur 24h), mm (minute), ss
            (seconde). Exemples : 'MM/dd/yyyy' s'affiche comme 01/31/2024, 'MMMM
            dd, yyyy' s'affiche comme January 31, 2024.
          enum:
            - MM/dd/yyyy
            - dd/MM/yyyy
            - yyyy-MM-dd
            - MMMM dd, yyyy
            - MMM dd, yyyy
            - dd MMMM yyyy
          default: MM/dd/yyyy
      example:
        dateFormat: MMMM dd, yyyy
    FieldValidationRules:
      type: object
      nullable: true
      description: >-
        Règles de validation pour les valeurs des champs. Réservé pour un usage
        futur, actuellement non appliqué pour aucun type de champ.
      additionalProperties: true
  responses:
    UnauthorizedError:
      description: Non Autorisé - Clé API invalide ou manquante
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unauthorized
            message: Invalid API key
    NotFoundError:
      description: Non Trouvé - La ressource n'existe pas
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Not Found
            message: The requested resource was not found
    RateLimitError:
      description: Trop de requêtes - Limite de débit dépassée
      headers:
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Nombre maximum de requêtes par minute
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Requêtes restantes
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Timestamp Unix de la réinitialisation
        Retry-After:
          schema:
            type: integer
          description: Secondes avant de pouvoir réessayer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Rate Limit Exceeded
            message: Too many requests. Please wait before retrying.
            details:
              retry_after: 45
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Clé API pour l'authentification. Utilisez votre clé API directement sans
        préfixe (par exemple, 'your-api-key'). Le préfixe Bearer est optionnel
        mais pas obligatoire.

````