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

# Obtener campos de la plantilla

> Recupera todos los campos configurados para una plantilla específica



## OpenAPI

````yaml api-reference/v01.30.00/openapi-v01.30.00.es.json get /templates/{id}/fields
openapi: 3.0.3
info:
  title: API de Socios de Firma
  description: >-
    API RESTful para firma de documentos y gestión de plantillas.


    **Autenticación**: Todos los endpoints requieren autenticación mediante
    clave API a través del encabezado `Authorization`. Usa tu clave API
    directamente sin ningún prefijo (por ejemplo, `your-api-key`). El prefijo
    Bearer es opcional pero no obligatorio.


    **Características de Seguridad**:

    - Validación de entrada usando esquemas Zod con mensajes de error detallados
    a nivel de campo

    - Tokens JWT firmados con RSA-256 para el acceso al Editor de Plantillas
    incrustado


    **Límite de Solicitudes**: Los límites de solicitudes están escalonados
    según el tipo de operación:

    - Operaciones de lectura (GET): 200 solicitudes por minuto

    - Operaciones de escritura (POST/PUT/PATCH/DELETE): 120 solicitudes por
    minuto

    - Operaciones CRUD de webhooks: 60 solicitudes por minuto

    - Prueba de webhook: 10 solicitudes por minuto

    - Regeneración/expiración de clave API: 1 solicitud por minuto

    - Rotación de secreto de webhook: 1 solicitud por minuto


    Cuando se superan los límites de solicitudes, la API devuelve una respuesta
    `429 Too Many Requests` con los encabezados:

    - `X-RateLimit-Limit`: Máximo de solicitudes por minuto para este endpoint

    - `X-RateLimit-Remaining`: Solicitudes restantes en la ventana actual

    - `X-RateLimit-Reset`: Marca de tiempo Unix de cuándo se restablece el
    límite

    - `Retry-After`: Segundos hasta que se permita reintentar


    **Manejo de Errores**: Todos los errores devuelven respuestas JSON
    estructuradas con `error` (mensaje legible para humanos), `code`
    (identificador legible por máquina) y `details` (errores de validación a
    nivel de campo cuando corresponda).


    **Integración del Editor de Plantillas Incrustado**: El Editor de Plantillas
    de Firma se puede incrustar en tu aplicación usando una biblioteca
    JavaScript independiente.


    ```html

    <!-- Carga la biblioteca del Editor de Plantillas de Firma -->

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


    <script>

    // Genera el token JWT vía API primero

    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 => {
      // Inicializa el editor con el token 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 Producción - Recomendada (Actual)
  - url: https://api.firma.dev/api/v1
    description: API de Producción - Planeada
security:
  - ApiKeyAuth: []
tags:
  - name: Company
    description: Información y configuración de la empresa
  - name: Workspaces
    description: Operaciones de gestión de espacios de trabajo
  - name: Templates
    description: Operaciones de gestión de plantillas
  - name: Signing Requests
    description: Operaciones de solicitudes de firma de documentos
  - name: Custom Fields
    description: >-
      Gestión de definiciones de campos personalizados para espacios de trabajo,
      plantillas y solicitudes de firma
  - name: Webhooks
    description: Configuración y gestión de webhooks
  - name: JWT Management
    description: Generación y revocación de tokens JWT para plantillas incrustadas
  - name: Workspace Settings
    description: Configuración y ajustes del espacio de trabajo
  - name: Email Domains
    description: >-
      Configuración y verificación de dominios de correo electrónico para enviar
      correos de solicitudes de firma desde dominios personalizados
  - name: Email Templates
    description: >-
      Gestión de plantillas de correo electrónico para personalización de
      notificaciones de solicitudes de firma a nivel de espacio de trabajo y de
      empresa
  - name: Signer Terms
    description: >-
      Términos de servicio / declaraciones de consentimiento personalizadas del
      firmante, a nivel de empresa con anulaciones por espacio de trabajo según
      el idioma
paths:
  /templates/{id}/fields:
    get:
      tags:
        - Templates
      summary: Obtener campos de la plantilla
      description: Recupera todos los campos configurados para una plantilla específica
      operationId: listTemplateFields
      parameters:
        - name: id
          in: path
          required: true
          description: ID de la plantilla
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Campos de la plantilla recuperados correctamente
          headers:
            X-RateLimit-Limit:
              schema:
                type: integer
              description: 'Límite de solicitudes: 200 solicitudes por minuto'
            X-RateLimit-Remaining:
              schema:
                type: integer
              description: Solicitudes restantes en la ventana actual
            X-RateLimit-Reset:
              schema:
                type: integer
              description: >-
                Marca de tiempo Unix cuando se restablece el límite de
                solicitudes
          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: Lista de campos de la plantilla
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/TemplateField'
      required:
        - results
    TemplateField:
      type: object
      description: Un campo colocado en un documento de plantilla
      properties:
        id:
          type: string
          format: uuid
          description: Identificador único del campo
        type:
          type: string
          enum:
            - text
            - signature
            - date
            - checkbox
            - dropdown
            - radio_buttons
            - number
            - text_area
            - file
            - initial
            - stamp
            - approval_signature
            - approval_checkmark
            - approval_date
          description: Tipo del campo
        required:
          type: boolean
          description: Indica si el campo es obligatorio
        recipient_id:
          type: string
          format: uuid
          nullable: true
          description: ID del destinatario asignado
        variable_name:
          type: string
          nullable: true
          description: Nombre de variable del campo (usado en plantillas)
        variable_defined_name:
          type: string
          nullable: true
          description: >-
            Nombre del campo legible para humanos, tomado de la definición del
            campo personalizado (por ejemplo, 'artist_name'). Solo está presente
            para campos vinculados a una definición de campo personalizado; de
            lo contrario es null.
        position:
          type: object
          description: >-
            Posición y dimensiones del campo en el documento. Todos los valores
            son porcentajes (0-100). El campo debe caber dentro de la página: x
            + width <= 100 y y + height <= 100.
          properties:
            x:
              type: number
              minimum: 0
              maximum: 100
              description: Coordenada X de la posición del campo (porcentaje, 0-100)
            'y':
              type: number
              minimum: 0
              maximum: 100
              description: Coordenada Y de la posición del campo (porcentaje, 0-100)
            width:
              type: number
              minimum: 0
              maximum: 100
              description: >-
                Ancho del campo (porcentaje, 0-100). Nota: x + width debe ser <=
                100
            height:
              type: number
              minimum: 0
              maximum: 100
              description: >-
                Alto del campo (porcentaje, 0-100). Nota: y + height debe ser <=
                100
        page_number:
          type: integer
          minimum: 1
          nullable: true
          description: >-
            Número de página donde se encuentra el campo (empieza en 1). No debe
            superar el total de páginas del documento.
        dropdown_options:
          nullable: true
          description: Opciones para campos desplegables
          oneOf:
            - type: array
              items:
                type: string
            - type: object
        multi_group_id:
          type: string
          format: uuid
          nullable: true
          description: >-
            ID de grupo para vincular varios campos de casilla de verificación o
            botón de opción entre sí. Los campos que comparten el mismo
            multi_group_id se comportan como un grupo mutuamente excluyente
            (como botones de opción): seleccionar uno deselecciona
            automáticamente los demás del grupo. Usa el mismo UUID en varios
            campos para crear un grupo donde solo se puede seleccionar una
            opción a la vez.
        date_default:
          type: string
          format: date
          nullable: true
          description: >-
            Valor de fecha predeterminado para campos de fecha (formato ISO
            8601, por ejemplo, '2024-01-15')
        date_signing_default:
          type: boolean
          description: >-
            Usar la fecha de firma como valor predeterminado para campos de
            fecha
        format_rules:
          $ref: '#/components/schemas/DateFormatRules'
          nullable: true
          description: >-
            Reglas de formato: actualmente se usan para campos de fecha, para
            especificar el formato de visualización
        validation_rules:
          $ref: '#/components/schemas/FieldValidationRules'
        read_only:
          type: boolean
          default: false
          description: Indica si este campo es de solo lectura (prellenado antes de firmar)
        read_only_value:
          type: string
          nullable: true
          description: Valor estático para campos de solo lectura
      required:
        - id
        - type
        - page_number
    Error:
      type: object
      properties:
        error:
          type: string
          description: Mensaje de error legible para humanos
        message:
          type: string
          description: Descripción detallada del error
        details:
          type: object
          description: Detalles adicionales del error
          additionalProperties: true
      required:
        - error
    DateFormatRules:
      type: object
      description: >-
        Reglas de formato para campos de fecha. Especifica cómo deben mostrarse
        y formatearse los valores de fecha.
      properties:
        dateFormat:
          type: string
          description: >-
            Patrón de formato de fecha. Usa formatos predefinidos o patrones
            personalizados con: yyyy (año de 4 dígitos), MM (mes de 2 dígitos),
            dd (día de 2 dígitos), MMMM (nombre completo del mes), MMM (nombre
            abreviado del mes), HH (hora en formato 24 horas), mm (minuto), ss
            (segundo). Ejemplos: 'MM/dd/yyyy' se muestra como 01/31/2024, 'MMMM
            dd, yyyy' se muestra como 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: >-
        Reglas de validación para valores de campo. Reservado para uso futuro:
        actualmente no se aplica a ningún tipo de campo.
      additionalProperties: true
  responses:
    UnauthorizedError:
      description: No Autorizado - Clave API inválida o faltante
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Unauthorized
            message: Invalid API key
    NotFoundError:
      description: No Encontrado - El recurso no existe
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Not Found
            message: The requested resource was not found
    RateLimitError:
      description: Demasiadas Solicitudes - Se superó el límite de solicitudes
      headers:
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Número máximo de solicitudes por minuto
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Solicitudes restantes
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Marca de tiempo Unix del reinicio
        Retry-After:
          schema:
            type: integer
          description: Segundos hasta que se permita reintentar
      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: >-
        Clave API para autenticación. Usa tu clave API directamente sin ningún
        prefijo (por ejemplo, 'your-api-key'). El prefijo Bearer es opcional
        pero no obligatorio.

````