> ## 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 utilisateurs du modèle

> Récupérer tous les destinataires/utilisateurs associés à un modèle spécifique



## OpenAPI

````yaml api-reference/v01.30.00/openapi-v01.30.00.fr.json get /templates/{id}/users
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}/users:
    get:
      tags:
        - Templates
      summary: Obtenir les utilisateurs du modèle
      description: >-
        Récupérer tous les destinataires/utilisateurs associés à un modèle
        spécifique
      operationId: listTemplateUsers
      parameters:
        - name: id
          in: path
          required: true
          description: ID du modèle
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Utilisateurs 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/TemplateUserListResponse'
              example:
                results:
                  - id: abc12345-e89b-12d3-a456-426614174000
                    name: John Doe
                    email: john@example.com
                    first_name: John
                    last_name: Doe
                    designation: Signer
                    order: 1
                    phone_number: null
                    street_address: null
                    city: null
                    state_province: null
                    postal_code: null
                    country: null
                    title: null
                    company: null
                    required_fields:
                      - email
                      - first_name
                    missing_fields: []
                    required_read_only_fields: []
                    ready_to_send: true
                  - id: def67890-e89b-12d3-a456-426614174000
                    name: null
                    email: null
                    first_name: null
                    last_name: null
                    designation: Signer
                    order: 2
                    phone_number: null
                    street_address: null
                    city: null
                    state_province: null
                    postal_code: null
                    country: null
                    title: null
                    company: null
                    required_fields:
                      - email
                      - first_name
                      - phone_number
                    missing_fields:
                      - email
                      - first_name
                      - phone_number
                    required_read_only_fields:
                      - variable_name: contract_date
                        field_type: date
                    ready_to_send: false
        '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.listTemplateUsers({
                id: "id"
            });
            console.log(response);
components:
  schemas:
    TemplateUserListResponse:
      type: object
      description: Liste des utilisateurs du modèle
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/TemplateUser'
      required:
        - results
    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
    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.

````