> ## 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 les champs d'une demande de signature

> Récupère tous les champs d'une demande de signature spécifique avec leurs valeurs



## OpenAPI

````yaml api-reference/v01.30.00/openapi-v01.30.00.fr.json get /signing-requests/{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:
  /signing-requests/{id}/fields:
    get:
      tags:
        - Signing Requests
      summary: Récupérer les champs d'une demande de signature
      description: >-
        Récupère tous les champs d'une demande de signature spécifique avec
        leurs valeurs
      operationId: listSigningRequestFields
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: ID de la demande de signature
      responses:
        '200':
          description: Champs de la demande de signature récupérés avec succès
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: 'Limite de débit : 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: Timestamp Unix de réinitialisation de la limite de débit
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SigningRequestFieldListResponse'
              example:
                results:
                  - id: field789-e89b-12d3-a456-426614174000
                    type: signature
                    recipient_id: user456-e89b-12d3-a456-426614174000
                    required: true
                    read_only: false
                    value: data:image/png;base64,iVBOR...
                    position:
                      x: 100.5
                      'y': 200.75
                      width: 200
                      height: 50
                    page_number: 1
                    variable_name: null
                    variable_defined_name: null
                    companies_workspaces_signing_requests_id: sr123-e89b-12d3-a456-426614174000
                    companies_workspaces_signing_requests_users_id: user456-e89b-12d3-a456-426614174000
                    field_type: signature
                    x_postion: 100.5
                    y_position: 200.75
                    width: 200
                    heigh: 50
                    final_value: data:image/png;base64,iVBOR...
                    deleted: 0
                  - id: field012-e89b-12d3-a456-426614174000
                    type: text
                    recipient_id: user456-e89b-12d3-a456-426614174000
                    required: true
                    read_only: false
                    value: Alice Johnson
                    position:
                      x: 150
                      'y': 300
                      width: 250
                      height: 30
                    page_number: 1
                    variable_name: full_name
                    variable_defined_name: null
                    companies_workspaces_signing_requests_id: sr123-e89b-12d3-a456-426614174000
                    companies_workspaces_signing_requests_users_id: user456-e89b-12d3-a456-426614174000
                    field_type: text
                    x_postion: 150
                    y_position: 300
                    width: 250
                    heigh: 30
                    final_value: Alice Johnson
                    deleted: 0
        '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.signingRequests.listSigningRequestFields({
                id: "id"
            });

            console.log(response);
components:
  schemas:
    SigningRequestFieldListResponse:
      type: object
      description: Liste des champs de la demande de signature
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/SigningRequestField'
      required:
        - results
    SigningRequestField:
      type: object
      description: >-
        Champ associé à une demande de signature, contenant des informations de
        position, de type et de valeur
      properties:
        id:
          type: string
          format: uuid
          description: Identifiant unique du champ
        type:
          type: string
          enum:
            - text
            - signature
            - date
            - checkbox
            - initial
            - dropdown
            - radio_buttons
            - text_area
            - url
            - file
            - stamp
            - approval_signature
            - approval_checkmark
            - approval_date
          description: Type du champ. Alias simplifié de field_type.
        recipient_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            ID du destinataire assigné à ce champ. Alias simplifié de
            companies_workspaces_signing_requests_users_id.
        value:
          type: string
          nullable: true
          description: Valeur finale signée du champ. Alias simplifié de final_value.
        position:
          type: object
          description: >-
            Position et dimensions du champ sur le document. Toutes les valeurs
            sont des pourcentages (0-100).
          properties:
            x:
              type: number
              nullable: true
              description: Position X (pourcentage, 0-100). Alias simplifié de x_postion.
            'y':
              type: number
              nullable: true
              description: Position Y (pourcentage, 0-100). Alias simplifié de y_position.
            width:
              type: number
              nullable: true
              description: Largeur (pourcentage, 0-100).
            height:
              type: number
              nullable: true
              description: Hauteur (pourcentage, 0-100). Alias simplifié de heigh.
        companies_workspaces_signing_requests_id:
          type: string
          format: uuid
          description: >-
            Déprécié : redondant avec le paramètre de chemin. ID de la demande
            de signature à laquelle ce champ appartient.
        companies_workspaces_signing_requests_users_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            Déprécié : utilisez 'recipient_id' à la place. ID du destinataire
            assigné à ce champ.
        field_type:
          type: string
          enum:
            - text
            - signature
            - date
            - checkbox
            - initial
            - dropdown
            - radio_buttons
            - text_area
            - url
            - file
            - stamp
            - approval_signature
            - approval_checkmark
            - approval_date
          description: 'Déprécié : utilisez ''type'' à la place. Type du champ.'
        required:
          type: boolean
          description: Indique si le champ est requis.
        x_postion:
          type: number
          nullable: true
          description: >-
            Déprécié : utilisez 'position.x' à la place. Position X (remarque :
            le nom de la colonne contient une faute de frappe).
        y_position:
          type: number
          nullable: true
          description: 'Déprécié : utilisez ''position.y'' à la place. Position Y du champ.'
        width:
          type: number
          nullable: true
          description: 'Déprécié : utilisez ''position.width'' à la place. Largeur du champ.'
        heigh:
          type: number
          nullable: true
          description: >-
            Déprécié : utilise plutôt 'position.height'. Hauteur (note : le nom
            de la colonne contient une faute de frappe).
        page_number:
          type: integer
          nullable: true
          description: Numéro de page où se trouve le champ (indexé à partir de 1)
        tl_position:
          type: number
          nullable: true
          description: Position du coin supérieur gauche
        tr_position:
          type: number
          nullable: true
          description: Position du coin supérieur droit
        bl_position:
          type: number
          nullable: true
          description: Position du coin inférieur gauche
        br_position:
          type: number
          nullable: true
          description: Position du coin inférieur droit
        variable_name:
          type: string
          nullable: true
          description: Nom de variable pour le mapping des données pré-remplies
        variable_defined_name:
          type: string
          nullable: true
          description: >-
            Nom de champ lisible provenant de la définition du champ
            personnalisé (ex. 'artist_name'). Présent uniquement pour les champs
            liés à une définition de champ personnalisé, sinon null.
        final_value:
          type: string
          nullable: true
          description: 'Déprécié : utilise plutôt ''value''. Valeur finale signée du champ.'
        date_default:
          type: string
          nullable: true
          description: Valeur de date par défaut
        date_signing_default:
          type: boolean
          nullable: true
          description: >-
            Indique s'il faut utiliser la date de signature comme valeur par
            défaut.
        format_rules:
          type: object
          nullable: true
          description: Règles de formatage (ex. format de date)
        validation_rules:
          type: object
          nullable: true
          description: Règles de validation pour le champ
        dropdown_options:
          nullable: true
          description: Options pour les champs de type liste déroulante
          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 bouton
            radio ensemble. Les champs partageant le même multi_group_id se
            comportent comme un groupe mutuellement exclusif (comme des boutons
            radio) - sélectionner l'un désélectionne automatiquement les autres
            du groupe. Utilise le même UUID sur plusieurs champs pour créer un
            groupe où une seule option peut être sélectionnée à la fois.
        read_only:
          type: boolean
          description: Indique si le champ est en lecture seule.
        read_only_value:
          type: string
          nullable: true
          description: Valeur statique pour les champs en lecture seule
        background_color:
          type: string
          nullable: true
          description: Couleur de fond en hexadécimal (ex. '#FFFDE7')
        calculated_font_size:
          type: number
          nullable: true
          description: Taille de police calculée pour le champ
        deleted:
          type: integer
          enum:
            - 0
            - 1
          description: >-
            Déprécié : champ interne, sera supprimé en v2. Indicateur de
            suppression logique (0 = actif, 1 = supprimé).
      required:
        - id
        - field_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
  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.

````