> ## 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.

# Obtenir les champs du modèle

> Récupérer tous les champs configurés pour un modèle spécifique



## OpenAPI

````yaml api-reference/v01.30.00/openapi-v01.30.00.fr.json get /templates/{id}/fields
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}/fields:
    get:
      tags:
        - Templates
      summary: Obtenir les champs du modèle
      description: Récupérer tous les champs configurés pour un modèle spécifique
      operationId: listTemplateFields
      parameters:
        - name: id
          in: path
          required: true
          description: ID du modèle
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Champs du modèle récupérés 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
              description: Requêtes restantes dans la fenêtre actuelle
            X-RateLimit-Reset:
              schema:
                type: integer
              description: Horodatage Unix de la réinitialisation de la limite de taux
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateFieldListResponse'
              example:
                results:
                  - id: field123-e89b-12d3-a456-426614174000
                    type: signature
                    required: true
                    recipient_id: user123-uuid
                    variable_name: null
                    position:
                      x: 100
                      'y': 200
                      width: 200
                      height: 50
                    page_number: 1
                    dropdown_options: null
                    multi_group_id: null
                    date_signing_default: false
                    format_rules: null
                    validation_rules: null
                    read_only: false
                    read_only_value: null
                  - id: field456-e89b-12d3-a456-426614174000
                    type: date
                    required: true
                    recipient_id: user123-uuid
                    variable_name: null
                    position:
                      x: 100
                      'y': 250
                      width: 150
                      height: 30
                    page_number: 1
                    dropdown_options: null
                    multi_group_id: null
                    date_signing_default: true
                    format_rules:
                      date_format: MM/DD/YYYY
                    validation_rules: null
                    read_only: false
                    read_only_value: null
        '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.listTemplateFields({
                id: "id"
            });
            console.log(response);
components:
  schemas:
    TemplateFieldListResponse:
      type: object
      description: Liste des champs du modèle
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/TemplateField'
      required:
        - results
    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.

````